REST API
Company Peers API
Generated from the Celerp 2.9.0 OpenAPI schema, .
GET /company-peers/grants
List Peer Grants
Responses
| Status | Description | Body |
|---|
200 | Successful Response | -- |
Example
curl -X GET http://localhost:8000/company-peers/grants \
-H "Authorization: Bearer $TOKEN"
POST /company-peers/grants
Create Peer Grant
Request body
| Field | Type | Required | Description |
|---|
source_company_id | string | yes | Source Company Id |
label | string | yes | Label |
firm | string | yes | Firm |
scopes | array of string | yes | Scopes |
Responses
| Status | Description | Body |
|---|
201 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/company-peers/grants \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'
POST /company-peers/grants/{grant_id}/renew
Renew Peer Grant
Parameters
| Name | In | Required | Type | Description |
|---|
grant_id | path | yes | string | Identifier of the company-to-company access grant to renew. |
Responses
| Status | Description | Body |
|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/company-peers/grants/:grant_id/renew \
-H "Authorization: Bearer $TOKEN"
POST /company-peers/grants/{grant_id}/revoke
Revoke Peer Grant
Parameters
| Name | In | Required | Type | Description |
|---|
grant_id | path | yes | string | Identifier of the company-to-company access grant to revoke. |
Responses
| Status | Description | Body |
|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/company-peers/grants/:grant_id/revoke \
-H "Authorization: Bearer $TOKEN"
GET /company-peers/verify
Verify Peer Grant
Parameters
| Name | In | Required | Type | Description |
|---|
source_company_id | query | yes | string | Identifier of the source company whose access grant is being verified. |
authorization | header | -- | string | Authorization credential supplied for verification of the company access grant. |
Responses
| Status | Description | Body |
|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/company-peers/verify \
-H "Authorization: Bearer $TOKEN"