Pular para o conteúdo principal

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/document
MÉTODO
POST

Path Params

CampoTipoDescriçãoCaracteres Máx.
OPERATION-KEY *stringChave única da operação (UUID v4).36
RELATED-PARTY-KEY *stringChave única da parte relacionada (UUID v4).36
Request Body
{
"document_base64": "dGVzdGVfZG9jdW1lbnRfYmFzZTY0",
"document_type": "cnh"
}

Request Body Params

CampoTipoDescriçãoCaracteres Máx.
document_base64 *stringConteúdo do arquivo do documento codificado em Base64.-
document_type *stringTipo do documento enviado.Enumeradores document_type

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

CampoTipoDescriçãoCaracteres Máx.
document_key *stringIdentificador único do documento enviado.36
document_type *stringTipo do documento enviado.Enumeradores document_type
ocr_keystringChave 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-KEY
MÉTODO
DELETE

Path Params

CampoTipoDescriçãoCaracteres Máx.
OPERATION-KEY *stringChave única da operação (UUID v4).36
RELATED-PARTY-KEY *stringChave única da parte relacionada (UUID v4).36
DOCUMENT-KEY *stringChave única do documento a ser removido.36

Response

STATUS
204

Nenhum conteúdo é retornado no corpo da resposta.

Enumeradores document_type

EnumDescrição
danfeDANFE (Documento Auxiliar da NF-e).
proof_of_addressComprovante de Endereço.
letter_of_attorneyProcuração.
company_statuteEstatuto da Empresa.
cnhCarteira Nacional de Habilitação (CNH).
cnh_frontFrente da CNH.
cnh_backVerso da CNH.
cnh_digitalCNH Digital.
rg_frontFrente do RG.
rg_backVerso do RG.