Initial Guide
- About Credit as a Service
- Credit Operations
Developer's Guide
- API Integration Guide
APIs Reference
- Simulations
- Onboarding
- POST1 - Client Registration
- POST2 - Address Registration
- POST3 - Document Consultation
- POST4 - Person Consultation
- POST5 - Onboarding Status Consultation
- POST6 - Include Document
- POST7 - Include Person Onboarding
- POST8 - Save Addresses
- POST9 - Save Partner
- POST10 - Save Partners
- POST11 - Include Guarantor
- POST12 - Include Guarantors
- POST
- Hiring
- Guarantees
- Document Printing
- Signatures
- Disbursement
Use Cases
- Personal Loan
Onboarding
6 - Include Document
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/IncluirDocumento \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"documentoCliente": "<string>"
},
"documento": {
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tipoDocumento": 4999,
"nomeArquivo": "<string>",
"extensao": "<string>",
"dtValidade": "2023-11-07T05:31:56Z",
"arquivo": "aSDinaTvuI8gbWludGxpZnk="
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tipoDocumento": 123,
"nomeArquivo": "<string>",
"extensao": "<string>",
"dtValidade": "2023-11-07T05:31:56Z",
"arquivo": "aSDinaTvuI8gbWludGxpZnk="
}
Through this endpoint, the partner uploads a document and attaches it to the person’s record.
Categoria | Operação | Ação | Código | Código Detalhado | Mensagem |
---|---|---|---|---|---|
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0049 | V0001 | Informe o nome do arquivo |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0049 | V0002 | Falha ao enviar Documento |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0049 | V0003 | Documento não pode ser alterado pois está em processo de análise automática. |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0108 | V0001 | Documento Federal deve ser informado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0108 | V0002 | Cliente não encontrado com o documento {documentoCliente} |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0108 | V0003 | Cliente não cadastrado pelo parceiro de integração |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0107 | V0001 | Extensão do arquivo é inválida. Permitido: [txt,bmp,jpg,jpeg,gif,png,pdf,doc,docx,xls,xlsx,zip] |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0107 | V0002 | Tipo de Documento inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0107 | V0003 | Documento deve ser enviado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | C0020 | V0001 | Extensão do arquivo é inválida. Permitido: [{GRANTTYPES}] |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0001 | Tipo de Parceiro inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0002 | CPF Inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0003 | CNPJ Inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0004 | Documento já cadastrado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0005 | Documento já cadastrado em outro registro |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0006 | Nome deve ser informado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0007 | Origem de Cliente inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0008 | Informe o campo [Cliente Desde] |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0596 | D0009 | Atividade Profissional Inválida |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0001 | Informe o Cliente |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0002 | Documento do Cliente é inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0016 | EPCodigo não informado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0017 | Vendedor não encontrado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0018 | Promotor não encontrado |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0019 | Informe o Tipo de Operação |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0020 | Informe o Valor |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0021 | Informe a Quantidade de Parcelas |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0022 | Formato de cálculo inválido |
Pessoa | UploadDocumentoPessoa | IncluirDocumento | T0665 | D0023 | Cliente deve ser pessoa física |
Authorizations
Informe o token
Headers
Body
Código do tipo de documento. Exemplo: 30 – Cédula de Crédito Bancária (CCB)
Required range:
0 <= x <= 9999
Nome do arquivo
Maximum length:
255
Extensão do arquivo
Maximum length:
20
Conteúdo base64 que representa o arquivo
Data de validade do documento quando requisitado
Response
200
text/plain
OK
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/IncluirDocumento \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"documentoCliente": "<string>"
},
"documento": {
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tipoDocumento": 4999,
"nomeArquivo": "<string>",
"extensao": "<string>",
"dtValidade": "2023-11-07T05:31:56Z",
"arquivo": "aSDinaTvuI8gbWludGxpZnk="
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tipoDocumento": 123,
"nomeArquivo": "<string>",
"extensao": "<string>",
"dtValidade": "2023-11-07T05:31:56Z",
"arquivo": "aSDinaTvuI8gbWludGxpZnk="
}