Skip to main content

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/OPERATION-KEY/related_party/RELATED-PARTY-KEY/document
METHOD
POST

Path Params​

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
RELATED-PARTY-KEY *stringUnique related party key (UUID v4).36
Request Body
{
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0",
"document_type": "cnh"
}

Request Body Params​

FieldTypeDescriptionMax Characters
document_base64 *stringDocument file content encoded in Base64.-
document_type *stringType of document being uploaded.document_type Enumerators

Response​

STATUS
201
Response Body
{
"document_key": "123e4567-e89b-12d3-a456-426614174000",
"document_type": "proof_of_identity",
"ocr_key": "123e4567-e89b-12d3-a456-426614174000"
}

Response Body Params​

FieldTypeDescriptionMax Characters
document_key *stringUnique identifier of the uploaded document.36
document_type *stringType of uploaded document.document_type Enumerators
ocr_keystringOCR key associated with the uploaded document.36

Representative Document Removal (DELETE)​

Request​

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/related_party/RELATED-PARTY-KEY/document/DOCUMENT-KEY
METHOD
DELETE

Path Params​

FieldTypeDescriptionMax Characters
OPERATION-KEY *stringUnique operation key (UUID v4).36
RELATED-PARTY-KEY *stringUnique related party key (UUID v4).36
DOCUMENT-KEY *stringUnique key of the document to be removed.36

Response​

STATUS
204

No content is returned in the response body.

document_type Enumerators​

EnumDescription
danfeDANFE (Auxiliary Document of NF-e).
proof_of_addressProof of Address.
letter_of_attorneyPower of Attorney.
company_statuteCompany Statute.
cnhNational Driver's License (CNH).
cnh_frontCNH Front.
cnh_backCNH Back.
cnh_digitalDigital CNH.
rg_frontID Front.
rg_backID Back.