/api/p/v{version}/carriers/{carrierId}/document

Upload a document to a specific carrier. Supports multipart/form-data. Each request must contain exactly one file.

Max file size: 25 MB
Allowed MIME types: application/pdf, image/jpeg, image/png
Allowed Document Types: Carrier Agreement, Carrier Application, Carrier Authority, Carrier Onboarding, Other Documents

Parameters

Parameter	In	Type	Required	Description
`carrierId`	path	string	Yes	Unique identifier of the carrier
`version`	path	string	Yes	API version (e.g., `1.0`)

Request Body

multipart/form-data

Parameter	Type	Required	Description
`File`	binary	Yes	The file to upload (PDF, JPEG, PNG). Max size 25 MB.
`FileName`	string	No	Optional custom filename (if omitted, filename is taken from multipart part)
`DocumentType`	string	Yes	The type of document. Must match one of the allowed document types.

Example Request (cURL)

curl -X POST "{{host}}/api/p/v1/carriers/{carrierId}/document" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "File=@Carrier_Agreement.pdf" \
  -F "DocumentType=Carrier Agreement"

Response Body

Name	Type	Description
`id`	string	Unique identifier of the uploaded document
`AttachmentPath`	string	File name/path assigned on upload + timestamp suffix (e.g., `1757343192`)
`AttachmentType`	string	Type of document (matches `DocumentType`)
`AttachmentSize`	integer	Size of the file in bytes
`UploadedAt`	string	UTC timestamp when the file was uploaded (ISO 8601)
`ParentId`	string	Identifier of the parent entity (the `{carrierId}`)
`ParentType`	string	Entity type the document is attached to (`Carrier`)

Example Response

200 OK

{
  "id": "b7a2d8c1-005e-4903-a4ee-45ca5e86411a",
  "AttachmentPath": "Carrier_Agreement-1757343192.pdf",
  "AttachmentType": "Carrier Agreement",
  "AttachmentSize": 3145728,
  "UploadedAt": "2025-09-09T08:26:03.194Z",
  "ParentId": "b7a000c1-005e-0000-a4ee-45ca5e00000a",
  "ParentType": "Carrier"
}

On the right side, you can see examples of different error codes by clicking Example and selecting the response code.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information, see the Rate Limits section.

Try It Out

This page is interactive, allowing you to try a request by specifying the API version and carrierId in the URL path.

As you fill out the parameters, the cURL command on the right side of the page will be automatically updated. Alternatively, you can directly edit the cURL command.

⚠️ Don’t forget: make sure to authorize yourself before trying a request.