Envio e Remoção de Documentos de Representantes de Partes Relacionadas
Este conjunto de endpoints permite o envio e a remoção de documentos associados a representantes de partes relacionadas a uma operação.
Envio de Documento do Representante (POST)
Request
ENDPOINT
/commercial_paper/OPERATION-KEY/related_party/RELATED-PARTY-KEY/documentMÉTODO
POSTPath Params
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
OPERATION-KEY * | string | Chave única da operação (UUID v4). | 36 |
RELATED-PARTY-KEY * | string | Chave única da parte relacionada (UUID v4). | 36 |
Request Body
{
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0",
"document_type": "cnh"
}
Request Body Params
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
document_base64 * | string | Conteúdo do arquivo do documento codificado em Base64. | - |
document_type * | string | Tipo do documento enviado. | Enumeradores document_type |
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
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
document_key * | string | Identificador único do documento enviado. | 36 |
document_type * | string | Tipo do documento enviado. | Enumeradores document_type |
ocr_key | string | Chave OCR associada ao documento enviado. | 36 |
Remoção de Documento do Representante (DELETE)
Request
ENDPOINT
/commercial_paper/OPERATION-KEY/related_party/RELATED-PARTY-KEY/document/DOCUMENT-KEYMÉTODO
DELETEPath Params
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
OPERATION-KEY * | string | Chave única da operação (UUID v4). | 36 |
RELATED-PARTY-KEY * | string | Chave única da parte relacionada (UUID v4). | 36 |
DOCUMENT-KEY * | string | Chave única do documento a ser removido. | 36 |
Response
STATUS
204Nenhum conteúdo é retornado no corpo da resposta.
Enumeradores document_type
Enum | Descrição |
---|---|
danfe | DANFE (Documento Auxiliar da NF-e). |
proof_of_address | Comprovante de Endereço. |
letter_of_attorney | Procuração. |
company_statute | Estatuto da Empresa. |
cnh | Carteira Nacional de Habilitação (CNH). |
cnh_front | Frente da CNH. |
cnh_back | Verso da CNH. |
cnh_digital | CNH Digital. |
rg_front | Frente do RG. |
rg_back | Verso do RG. |