Related Party Representative Document Upload and Removal
This set of endpoints allows uploading and removing documents associated with related party representatives to an operation.
Representative Document Upload (POST)
Request
ENDPOINT
/commercial_paper/OPERATION-KEY/related_party/RELATED-PARTY-KEY/documentMETHOD
POSTPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
RELATED-PARTY-KEY * | string | Unique related party key (UUID v4). | 36 |
Request Body
{
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0",
"document_type": "cnh"
}
Request Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
document_base64 * | string | Document file content encoded in Base64. | - |
document_type * | string | Type of document being uploaded. | document_type Enumerators |
Response
STATUS
201Response Body
{
"document_key": "123e4567-e89b-12d3-a456-426614174000",
"document_type": "proof_of_identity",
"ocr_key": "123e4567-e89b-12d3-a456-426614174000"
}
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
document_key * | string | Unique identifier of the uploaded document. | 36 |
document_type * | string | Type of uploaded document. | document_type Enumerators |
ocr_key | string | OCR key associated with the uploaded document. | 36 |
Representative Document Removal (DELETE)
Request
ENDPOINT
/commercial_paper/OPERATION-KEY/related_party/RELATED-PARTY-KEY/document/DOCUMENT-KEYMETHOD
DELETEPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
OPERATION-KEY * | string | Unique operation key (UUID v4). | 36 |
RELATED-PARTY-KEY * | string | Unique related party key (UUID v4). | 36 |
DOCUMENT-KEY * | string | Unique key of the document to be removed. | 36 |
Response
STATUS
204No content is returned in the response body.
document_type Enumerators
| Enum | Description |
|---|---|
danfe | DANFE (Auxiliary Document of NF-e). |
proof_of_address | Proof of Address. |
letter_of_attorney | Power of Attorney. |
company_statute | Company Statute. |
cnh | National Driver's License (CNH). |
cnh_front | CNH Front. |
cnh_back | CNH Back. |
cnh_digital | Digital CNH. |
rg_front | ID Front. |
rg_back | ID Back. |