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
- CDC (Partner A)
Onboarding
1 - Client Registration
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigo": "<string>",
"nome": "<string>",
"documentoFederal": "<string>",
"identificadorEmpresaERP": "<string>",
"codigoAtividadeProfissional": 4999,
"textoInfoHistCliente": "<string>",
"score": "<string>",
"rating": "<string>",
"pf": {
"apelido": "<string>",
"rg": "<string>",
"rgOrgao": "<string>",
"rguf": "<string>",
"rgData": "<string>",
"dtNasc": "<string>",
"sexo": "<string>",
"nacionalidade": "<string>",
"naturalDeCidade": "<string>",
"naturalDeUF": "<string>",
"estadoCivil": 4999,
"escolaridade": 4999,
"nomeCargo": "<string>",
"tipoOcupacao": 4999,
"outrasRendas": "<string>",
"vlrOutrasRendas": 5000000000000000,
"nomePai": "<string>",
"telefonePai": "<string>",
"emailPai": "<string>",
"nomeMae": "<string>",
"telefoneMae": "<string>",
"emailMae": "<string>",
"nomeConjuge": "<string>",
"dtNascConjuge": "<string>",
"telefoneFixoConjuge": "<string>",
"telefoneCelularConjuge": "<string>",
"emailConjuge": "<string>",
"tempoCasadoConjuge": 4999,
"cpfConjuge": "<string>",
"rgConjuge": "<string>",
"rgOrgaoConjuge": "<string>",
"rgufConjuge": "<string>",
"rgDataConjuge": "<string>",
"mostrarConjugeCCB": true,
"fielDepositario": true,
"terceiroGarantidor": true
},
"pj": {
"nomeFantasia": "<string>",
"documentoEstadual": "<string>",
"documentoMunicipal": "<string>",
"dtAberturaEmpresa": "<string>",
"nomeResponsavelEmpresa": "<string>",
"cpfResponsavelEmpresa": "<string>",
"rgResponsavelEmpresa": "<string>",
"codigoRede": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"pessoaDadosContato": {
"email": "<string>",
"telefoneFixo1": "<string>",
"telefoneFixo2": "<string>",
"telefoneCelular1": "<string>",
"telefoneCelular2": "<string>",
"telefoneFax": "<string>",
"paginaWeb": "<string>"
},
"pessoaDadoFinanceiro": {
"ano1": 123,
"ano1VlrAtivoCirculante": 123,
"ano1VlrAtivoImobilizado": 123,
"ano1VlrCapitalTerceiros": 123,
"ano1VlrReceitaOperacionalBruta": 123,
"ano1VlrDisponibilidade": 123,
"ano1VlrEstoque": 123,
"ano1VlrPassivoCirculante": 123,
"ano1VlrResultadoOperacionalBruto": 123,
"ano1VlrPatrimonioLiquido": 123,
"ano1VlrPassivoNaoCirculante": 123,
"ano1VlrAtivoNaoCirculante": 123,
"ano1VlrReceitaOperacionalLiquida": 123,
"ano2": 123,
"ano2VlrAtivoCirculante": 123,
"ano2VlrAtivoImobilizado": 123,
"ano2VlrCapitalTerceiros": 123,
"ano2VlrReceitaOperacionalBruta": 123,
"ano2VlrDisponibilidade": 123,
"ano2VlrEstoque": 123,
"ano2VlrPassivoCirculante": 123,
"ano2VlrResultadoOperacionalBruto": 123,
"ano2VlrPatrimonioLiquido": 123,
"ano2VlrPassivoNaoCirculante": 123,
"ano2VlrAtivoNaoCirculante": 123,
"ano2VlrReceitaOperacionalLiquida": 123,
"ano3": 123,
"ano3VlrAtivoCirculante": 123,
"ano3VlrAtivoImobilizado": 123,
"ano3VlrCapitalTerceiros": 123,
"ano3VlrReceitaOperacionalBruta": 123,
"ano3VlrDisponibilidade": 123,
"ano3VlrEstoque": 123,
"ano3VlrPassivoCirculante": 123,
"ano3VlrResultadoOperacionalBruto": 123,
"ano3VlrPatrimonioLiquido": 123,
"ano3VlrPassivoNaoCirculante": 123,
"ano3VlrAtivoNaoCirculante": 123,
"ano3VlrReceitaOperacionalLiquida": 123,
"faturamentoMes1": "<string>",
"vlrFaturamentoMes1": 5000000000000000,
"vlrFaturamentoMes2": 5000000000000000,
"vlrFaturamentoMes3": 5000000000000000,
"vlrFaturamentoMes4": 5000000000000000,
"vlrFaturamentoMes5": 5000000000000000,
"vlrFaturamentoMes6": 5000000000000000,
"vlrFaturamentoMes7": 5000000000000000,
"vlrFaturamentoMes8": 5000000000000000,
"vlrFaturamentoMes9": 5000000000000000,
"vlrFaturamentoMes10": 5000000000000000,
"vlrFaturamentoMes11": 5000000000000000,
"vlrFaturamentoMes12": 5000000000000000,
"irMes1": "<string>",
"vlrIRMes1": 5000000000000000,
"vlrIRMes2": 5000000000000000,
"vlrIRMes3": 5000000000000000,
"vlrIRMes4": 5000000000000000,
"vlrIRMes5": 5000000000000000,
"vlrIRMes6": 5000000000000000,
"vlrIRMes7": 5000000000000000,
"vlrIRMes8": 5000000000000000,
"vlrIRMes9": 5000000000000000,
"vlrIRMes10": 5000000000000000,
"vlrIRMes11": 5000000000000000,
"vlrIRMes12": 5000000000000000,
"extratoMes1": "<string>",
"vlrExtratoMes1": 5000000000000000,
"vlrExtratoMes2": 5000000000000000,
"vlrExtratoMes3": 5000000000000000,
"vlrExtratoMes4": 5000000000000000,
"vlrExtratoMes5": 5000000000000000,
"vlrExtratoMes6": 5000000000000000,
"vlrExtratoMes7": 5000000000000000,
"vlrExtratoMes8": 5000000000000000,
"vlrExtratoMes9": 5000000000000000,
"vlrExtratoMes10": 5000000000000000,
"vlrExtratoMes11": 5000000000000000,
"vlrExtratoMes12": 5000000000000000,
"vlrFaturamentoMes13": 5000000000000000,
"vlrFaturamentoMes14": 5000000000000000,
"vlrFaturamentoMes15": 5000000000000000,
"vlrFaturamentoMes16": 5000000000000000,
"vlrFaturamentoMes17": 5000000000000000,
"vlrFaturamentoMes18": 5000000000000000,
"vlrFaturamentoMes19": 5000000000000000,
"vlrFaturamentoMes20": 5000000000000000,
"vlrFaturamentoMes21": 5000000000000000,
"vlrFaturamentoMes22": 5000000000000000,
"vlrFaturamentoMes23": 5000000000000000,
"vlrFaturamentoMes24": 5000000000000000,
"recebiveisMes1": "<string>",
"vlrRecebiveisMes1": 5000000000000000,
"vlrRecebiveisMes2": 5000000000000000,
"vlrRecebiveisMes3": 5000000000000000,
"vlrRecebiveisMes4": 5000000000000000,
"vlrRecebiveisMes5": 5000000000000000,
"vlrRecebiveisMes6": 5000000000000000,
"vlrRecebiveisMes7": 5000000000000000,
"vlrRecebiveisMes8": 5000000000000000,
"vlrRecebiveisMes9": 5000000000000000,
"vlrRecebiveisMes10": 5000000000000000,
"vlrRecebiveisMes11": 5000000000000000,
"vlrRecebiveisMes12": 5000000000000000,
"anoMesInicioFaturamento": "<string>",
"anoMesInicioRecebiveis": "<string>"
},
"pessoaQualificacao": {
"codigo": "<string>",
"codigoProfissao": 4999,
"vlrRenda": 49999999.95,
"dtAdmissao": "2023-11-07T05:31:56Z",
"dtDemissao": "2023-11-07T05:31:56Z",
"nroMatricula": "<string>",
"nomeEmpresa": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"telefoneFixo": "<string>"
}
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Through this endpoint, the partner registers and updates a record of an individual or legal entity for which payment will be made. The registered information can include general, contact, and financial details. This procedure must be executed before any other endpoint related to the Person API.
Categoria | Operação | Ação | Código | Código Detalhado | Mensagem |
---|---|---|---|---|---|
Pessoa | CreateUpdatePessoa | Salvar | C0041 | V0001 | Documento não é PF ou PJ |
Pessoa | CreateUpdatePessoa | Salvar | C0041 | V0002 | Dados da PF devem ser enviados |
Pessoa | CreateUpdatePessoa | Salvar | C0041 | V0003 | Dados da PJ devem ser enviados |
Pessoa | CreateUpdatePessoa | Salvar | C0041 | V0004 | Dados de Contato devem ser enviados |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0001 | Tipo de Parceiro inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0002 | CPF Inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0003 | CNPJ Inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0004 | Documento já cadastrado |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0005 | Documento já cadastrado em outro registro |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0006 | Nome deve ser informado |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0007 | Origem de Cliente inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0008 | Informe o campo [Cliente Desde] |
Pessoa | CreateUpdatePessoa | Salvar | T0596 | D0009 | Atividade Profissional Inválida |
Pessoa | CreateUpdatePessoa | Salvar | T0617 | D0001 | CPF do Cônjuge é inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0617 | D0002 | Cliente menor de 18 anos |
Pessoa | CreateUpdatePessoa | Salvar | T0617 | D0003 | Cliente tem mais de 80 anos |
Pessoa | CreateUpdatePessoa | Salvar | T0617 | D0004 | Gênero inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0617 | D0005 | Estado Civil não localizado |
Pessoa | CreateUpdatePessoa | Salvar | T0617 | D0006 | Escolaridade não localizada |
Pessoa | CreateUpdatePessoa | Salvar | T0618 | D0001 | CPF do Responsável da Empresa é inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0001 | E-mail inválido |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0002 | Informe o Telefone Fixo 1 com DDD |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0003 | Informe o Telefone Fixo 2 com DDD |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0004 | Informe o Telefone Celular 1 com DDD |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0005 | Informe o Telefone Celular 2 com DDD |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0006 | Informe o Telefone Fax com DDD |
Pessoa | CreateUpdatePessoa | Salvar | T0604 | D0007 | Deve existir pelo menos um telefone para contato |
Authorizations
Informe o token
Headers
Body
Response
200
text/plain
OK
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/Salvar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigo": "<string>",
"nome": "<string>",
"documentoFederal": "<string>",
"identificadorEmpresaERP": "<string>",
"codigoAtividadeProfissional": 4999,
"textoInfoHistCliente": "<string>",
"score": "<string>",
"rating": "<string>",
"pf": {
"apelido": "<string>",
"rg": "<string>",
"rgOrgao": "<string>",
"rguf": "<string>",
"rgData": "<string>",
"dtNasc": "<string>",
"sexo": "<string>",
"nacionalidade": "<string>",
"naturalDeCidade": "<string>",
"naturalDeUF": "<string>",
"estadoCivil": 4999,
"escolaridade": 4999,
"nomeCargo": "<string>",
"tipoOcupacao": 4999,
"outrasRendas": "<string>",
"vlrOutrasRendas": 5000000000000000,
"nomePai": "<string>",
"telefonePai": "<string>",
"emailPai": "<string>",
"nomeMae": "<string>",
"telefoneMae": "<string>",
"emailMae": "<string>",
"nomeConjuge": "<string>",
"dtNascConjuge": "<string>",
"telefoneFixoConjuge": "<string>",
"telefoneCelularConjuge": "<string>",
"emailConjuge": "<string>",
"tempoCasadoConjuge": 4999,
"cpfConjuge": "<string>",
"rgConjuge": "<string>",
"rgOrgaoConjuge": "<string>",
"rgufConjuge": "<string>",
"rgDataConjuge": "<string>",
"mostrarConjugeCCB": true,
"fielDepositario": true,
"terceiroGarantidor": true
},
"pj": {
"nomeFantasia": "<string>",
"documentoEstadual": "<string>",
"documentoMunicipal": "<string>",
"dtAberturaEmpresa": "<string>",
"nomeResponsavelEmpresa": "<string>",
"cpfResponsavelEmpresa": "<string>",
"rgResponsavelEmpresa": "<string>",
"codigoRede": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"pessoaDadosContato": {
"email": "<string>",
"telefoneFixo1": "<string>",
"telefoneFixo2": "<string>",
"telefoneCelular1": "<string>",
"telefoneCelular2": "<string>",
"telefoneFax": "<string>",
"paginaWeb": "<string>"
},
"pessoaDadoFinanceiro": {
"ano1": 123,
"ano1VlrAtivoCirculante": 123,
"ano1VlrAtivoImobilizado": 123,
"ano1VlrCapitalTerceiros": 123,
"ano1VlrReceitaOperacionalBruta": 123,
"ano1VlrDisponibilidade": 123,
"ano1VlrEstoque": 123,
"ano1VlrPassivoCirculante": 123,
"ano1VlrResultadoOperacionalBruto": 123,
"ano1VlrPatrimonioLiquido": 123,
"ano1VlrPassivoNaoCirculante": 123,
"ano1VlrAtivoNaoCirculante": 123,
"ano1VlrReceitaOperacionalLiquida": 123,
"ano2": 123,
"ano2VlrAtivoCirculante": 123,
"ano2VlrAtivoImobilizado": 123,
"ano2VlrCapitalTerceiros": 123,
"ano2VlrReceitaOperacionalBruta": 123,
"ano2VlrDisponibilidade": 123,
"ano2VlrEstoque": 123,
"ano2VlrPassivoCirculante": 123,
"ano2VlrResultadoOperacionalBruto": 123,
"ano2VlrPatrimonioLiquido": 123,
"ano2VlrPassivoNaoCirculante": 123,
"ano2VlrAtivoNaoCirculante": 123,
"ano2VlrReceitaOperacionalLiquida": 123,
"ano3": 123,
"ano3VlrAtivoCirculante": 123,
"ano3VlrAtivoImobilizado": 123,
"ano3VlrCapitalTerceiros": 123,
"ano3VlrReceitaOperacionalBruta": 123,
"ano3VlrDisponibilidade": 123,
"ano3VlrEstoque": 123,
"ano3VlrPassivoCirculante": 123,
"ano3VlrResultadoOperacionalBruto": 123,
"ano3VlrPatrimonioLiquido": 123,
"ano3VlrPassivoNaoCirculante": 123,
"ano3VlrAtivoNaoCirculante": 123,
"ano3VlrReceitaOperacionalLiquida": 123,
"faturamentoMes1": "<string>",
"vlrFaturamentoMes1": 5000000000000000,
"vlrFaturamentoMes2": 5000000000000000,
"vlrFaturamentoMes3": 5000000000000000,
"vlrFaturamentoMes4": 5000000000000000,
"vlrFaturamentoMes5": 5000000000000000,
"vlrFaturamentoMes6": 5000000000000000,
"vlrFaturamentoMes7": 5000000000000000,
"vlrFaturamentoMes8": 5000000000000000,
"vlrFaturamentoMes9": 5000000000000000,
"vlrFaturamentoMes10": 5000000000000000,
"vlrFaturamentoMes11": 5000000000000000,
"vlrFaturamentoMes12": 5000000000000000,
"irMes1": "<string>",
"vlrIRMes1": 5000000000000000,
"vlrIRMes2": 5000000000000000,
"vlrIRMes3": 5000000000000000,
"vlrIRMes4": 5000000000000000,
"vlrIRMes5": 5000000000000000,
"vlrIRMes6": 5000000000000000,
"vlrIRMes7": 5000000000000000,
"vlrIRMes8": 5000000000000000,
"vlrIRMes9": 5000000000000000,
"vlrIRMes10": 5000000000000000,
"vlrIRMes11": 5000000000000000,
"vlrIRMes12": 5000000000000000,
"extratoMes1": "<string>",
"vlrExtratoMes1": 5000000000000000,
"vlrExtratoMes2": 5000000000000000,
"vlrExtratoMes3": 5000000000000000,
"vlrExtratoMes4": 5000000000000000,
"vlrExtratoMes5": 5000000000000000,
"vlrExtratoMes6": 5000000000000000,
"vlrExtratoMes7": 5000000000000000,
"vlrExtratoMes8": 5000000000000000,
"vlrExtratoMes9": 5000000000000000,
"vlrExtratoMes10": 5000000000000000,
"vlrExtratoMes11": 5000000000000000,
"vlrExtratoMes12": 5000000000000000,
"vlrFaturamentoMes13": 5000000000000000,
"vlrFaturamentoMes14": 5000000000000000,
"vlrFaturamentoMes15": 5000000000000000,
"vlrFaturamentoMes16": 5000000000000000,
"vlrFaturamentoMes17": 5000000000000000,
"vlrFaturamentoMes18": 5000000000000000,
"vlrFaturamentoMes19": 5000000000000000,
"vlrFaturamentoMes20": 5000000000000000,
"vlrFaturamentoMes21": 5000000000000000,
"vlrFaturamentoMes22": 5000000000000000,
"vlrFaturamentoMes23": 5000000000000000,
"vlrFaturamentoMes24": 5000000000000000,
"recebiveisMes1": "<string>",
"vlrRecebiveisMes1": 5000000000000000,
"vlrRecebiveisMes2": 5000000000000000,
"vlrRecebiveisMes3": 5000000000000000,
"vlrRecebiveisMes4": 5000000000000000,
"vlrRecebiveisMes5": 5000000000000000,
"vlrRecebiveisMes6": 5000000000000000,
"vlrRecebiveisMes7": 5000000000000000,
"vlrRecebiveisMes8": 5000000000000000,
"vlrRecebiveisMes9": 5000000000000000,
"vlrRecebiveisMes10": 5000000000000000,
"vlrRecebiveisMes11": 5000000000000000,
"vlrRecebiveisMes12": 5000000000000000,
"anoMesInicioFaturamento": "<string>",
"anoMesInicioRecebiveis": "<string>"
},
"pessoaQualificacao": {
"codigo": "<string>",
"codigoProfissao": 4999,
"vlrRenda": 49999999.95,
"dtAdmissao": "2023-11-07T05:31:56Z",
"dtDemissao": "2023-11-07T05:31:56Z",
"nroMatricula": "<string>",
"nomeEmpresa": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"telefoneFixo": "<string>"
}
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Assistant
Responses are generated using AI and may contain mistakes.