Tabela de erros

Obter Token de Autenticação

POST https://auth.flowfinance.com.br/oauth2/token

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
invalid_client	—	400 Bad Request	400 - As credencias informadas são inválidas

Enviar KYC Externo

POST /banking/originator/persons/background-check/external

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	taxpayer_id: invalid Brazilian corporate taxpayer registry number (CNPJ), invalid Brazilian individual taxpayer registry number (CPF)	400 Bad Request	400 - O campo 'taxpayer' é inválido
Constraint violation error	taxpayer_id: must not be empty	400 Bad Request	400 - O campo 'taxpayer' é obrigatório
Invalid value for parameter named force	—	400 Bad Request	400 - O campo 'force' é inválido
Constraint violation error	taxpayer_id: invalid Brazilian corporate taxpayer registry number (CNPJ), invalid Brazilian individual taxpayer registry number (CPF)	400 Bad Request	400 - O campo 'taxpayer' é inválido
Constraint violation error	taxpayer_id: must not be empty	400 Bad Request	400 - O campo 'taxpayer' é obrigatório
Invalid value for parameter named force	—	400 Bad Request	400 - O campo 'force' é inválido

Consultar KYC de CPF

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar KYC de CPF de Forma Antecipada

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Termo de Aceite de SCR de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Entity not found error	—	404 Not Found	404 - Termo de aceite não foi encontrado

Criar Termo de Aceite de SCR de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
—	—	415 Unsupported Media Type	415 - O content-type não é permitido para requisição
Internal server error: arquivo inválido ou boundary multipart não encontrado	—	500 Internal Server Error	500 - Arquivo inválido ou não foi enviado

Consultar SCR Específico de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - O ID da Pessoa ou o ID do SCR não foi encontrado
Invalid value for parameter named scrId	—	400 Bad Request	400 - O parâmetro 'scr_id' é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar SCR de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - O ID da Pessoa não foi encontrado ou não pertence ao Originador
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar SCR por CPF/CNPJ

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Constraint violation error	evidence: must not be empty	400 Bad Request	400 - O campo 'evidence' é obrigatório
Constraint violation error	taxpayer_id: must not be empty	400 Bad Request	400 - O campo 'taxpayer_id' é obrigatório
Constraint violation error	taxpayer_id: invalid Brazilian corporate taxpayer registry number (CNPJ), invalid Brazilian individual taxpayer registry number (CPF)	400 Bad Request	400 - O valor informado no campo 'taxpayer_id' é inválido
Constraint violation error	taxpayer_id: invalid Brazilian individual taxpayer registry number (CPF), must not be empty, invalid Brazilian corporate taxpayer registry number (CNP...	400 Bad Request	400 - O valor informado no campo 'taxpayer_id' não pode ser vazio
Constraint violation error	evidence: must not be empty	400 Bad Request	400 - O valor informado no campo 'evidence' não pode ser vazio
Internal server error: valor inválido para o campo reference_date	—	500 Internal Server Error	500 - O valor informado no campo 'reference_date' é inválido ou está fora do formato esperado

Listar Consultas de SCR

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Fazer Download de Documento de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
—	—	500 Internal Server Error	500 - Arquivo não encontrado
entity not found for id id	—	404 Not Found	404 - Arquivo não encontrado
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Cadastrar Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	taxpayerId: must not be null	400 Bad Request	400 - O campo CPF (taxpayer_id) é obrigatório
Constraint violation error	taxpayer_id: invalid Brazilian taxpayer id number	400 Bad Request	400 - CPF (taxpayer_id) informado é inválido
A person with this taxpayer id already exists	—	400 Bad Request	400 - CPF informado já está cadastrado
Constraint violation error	taxpayer_id: must not be null	400 Bad Request	400 - Campo obrigatório não foi enviado (vide objeto 'detail')
Internal server error: valor inválido para o campo marital_status	—	500 Internal Server Error	500 - O valor/texto informado para o campo não pertence a lista de valores esperada
Constraint violation error	email_address: must be a well-formed email address	400 Bad Request	400 - O email informado é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Constraint violation error	fullName: must not be null	400 Bad Request	400 - O campo Nome (full_name) é obrigatório
Constraint violation error	nationality: must not be null	400 Bad Request	400 - O campo Nacionalidade (nationality) é obrigatório
Constraint violation error	occupation: must not be null	400 Bad Request	400 - O campo Ocupação (occupation) é obrigatório
Constraint violation error	phone: must not be null	400 Bad Request	400 - O campo Telefone (phone) é obrigatório
Constraint violation error	phone.countryCode: must not be blank	400 Bad Request	400 - O campo Código Pais do Telefone (phone.countryCode) é obrigatório
Constraint violation error	phone.areaCode: must not be blank	400 Bad Request	400 - O campo DDD (phone.areaCode) do telefone é obrigatório
Constraint violation error	phone.number: must not be blank	400 Bad Request	400 - O campo Numero do Telefone (phone.number) é obrigatório

Consultar Pessoas Cadastradas

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Pessoa por ID

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - Cadastro de pessoa não localizado
Invalid value for parameter named id	—	400 Bad Request	400 - O parâmetro informado está no formato inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Atualizar Cadastro de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	full_name: must not be null / occupation: must not be null / nationality: must not be null / phone: must not be null	400 Bad Request	400 - Campos obrigatórios não enviados
Constraint violation error	spouse_taxpayer_id: invalid Brazilian taxpayer id number	400 Bad Request	400 - O CPF informado está no formato inválido
Constraint violation error	email_address: must be a well-formed email address	400 Bad Request	400 - O e-mail informado é inválido
Internal server error: valor inválido para o campo spouse_date_of_birth	—	500 Internal Server Error	500 - O campo informado está no formato inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Cadastrar Documento de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	type: must not be null	400 Bad Request	400 - Um campo obrigatório não foi enviado (vide 'detail')
—	—	400 Bad Request	400 - O campo 'type' é inválido
—	—	415 Unsupported Media Type	415 - Tipo de arquivo inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido Copy

Consultar Documentos de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Invalid value for parameter named id	—	400 Bad Request	400 - O ID da Pessoa é inválido
entity not found for id id	—	404 Not Found	404 - O ID da Empresa não foi encontrado ou não pertence ao Originador Copy

Atualizar Documento de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	type: must not be null	400 Bad Request	400 - Um campo obrigatório não foi enviado (vide 'detail')
—	—	400 Bad Request	400 - O campo 'type' é inválido
Entity not found error	—	404 Not Found	404 - Arquivo não encontrado
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Excluir Documento de Pessoa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - Arquivo não encontrado
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Criar Relacionamento Pessoa x Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Internal server error: valor inválido para o campo id	—	500 Internal Server Error	500 - Um dos campos informados está no formato inválido
Internal server error: valor inválido para o campo type	—	500 Internal Server Error	500 - O valor do campo 'type' é inválido
Constraint violation error	type: must not be null	400 Bad Request	400 - Um campo obrigatório não foi enviado (vide campo 'detail')
entity not found for id id	—	404 Not Found	404 - O ID da Pessoa informado não foi encontrado ou não está associado ao Originador
Constraint violation error	share: must be less than or equal to 1	400 Bad Request	400 - O campo 'share' está no formato inválido
This relation already exists	—	400 Bad Request	400 - Já existe o relacionamento criado com essa Pessoa

Consultar Relacionamentos de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token inválido

Atualizar Relacionamento Pessoa x Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token inválido
entity not found for id id	—	404 Not Found	404 - O ID da Pessoa informado não foi encontrado ou não está associado ao Originador
Constraint violation error	type: must not be null	400 Bad Request	400 - Um campo obrigatório não foi enviado (vide campo 'detail')
Internal server error: valor inválido para o campo type	—	500 Internal Server Error	500 - O valor do campo 'type' é inválido
Constraint violation error	share: must be less than or equal to 1	400 Bad Request	400 - O campo 'share' está no formato inválido
Internal server error: valor inválido para o campo id	—	500 Internal Server Error	500 - Um dos campos informados está no formato inválido
Entity not found error	—	404 Not Found	400 - O campo 'relation_id' informado não foi encontrado ou é inválido
Invalid value for parameter named id	—	400 Bad Request	400 - O campo 'business_id' informado não foi encontrado ou é inválido

Remover Relacionamento Pessoa x Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Invalid value for parameter named relationId	—	400 Bad Request	400 - O campo 'relation_id' informado é inválido
Invalid value for parameter named id	—	400 Bad Request	400 - O campo 'business_id'informado é inválido

Consultar KYC de CNPJ de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar KYC de CNPJ de Forma Antecipada

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Termo de Aceite de SCR de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Entity not found error	—	404 Not Found	404 - Termo de aceite não foi encontrado

Criar Termo de Aceite SCR para Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
—	—	415 Unsupported Media Type	415 - O content-type não é permitido para requisição
Internal server error: arquivo inválido ou boundary multipart não encontrado	—	500 Internal Server Error	500 - Arquivo inválido ou não foi enviado

Consultar SCR Específico de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - O ID da Pessoa ou o ID do SCR não foi encontrado
Invalid value for parameter named scrId	—	400 Bad Request	400 - O parâmetro 'scr_id' é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar SCR de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - O ID da Pessoa não foi encontrado ou não pertence ao Originador
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar SCR por CNPJ

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Constraint violation error	evidence: must not be empty	400 Bad Request	400 - O campo 'evidence' é obrigatório
Constraint violation error	taxpayer_id: must not be empty	400 Bad Request	400 - O campo 'taxpayer_id' é obrigatório
Constraint violation error	taxpayer_id: invalid Brazilian corporate taxpayer registry number (CNPJ), invalid Brazilian individual taxpayer registry number (CPF)	400 Bad Request	400 - O valor informado no campo 'taxpayer_id' é inválido
Constraint violation error	taxpayer_id: invalid Brazilian individual taxpayer registry number (CPF), must not be empty, invalid Brazilian corporate taxpayer registry number (CNP...	400 Bad Request	400 - O valor informado no campo 'taxpayer_id' não pode ser vazio
Constraint violation error	evidence: must not be empty	400 Bad Request	400 - O valor informado no campo 'evidence' não pode ser vazio
Internal server error: valor inválido para o campo reference_date	—	500 Internal Server Error	500 - O valor informado no campo 'reference_date' é inválido ou está fora do formato esperado

Listar Consultas de SCR de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Cadastrar Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	taxpayer_id: must not be null	400 Bad Request	400 - Campo obrigatório não foi enviado (vide objeto 'detail')
A business with this taxpayer id already exists	—	400 Bad Request	400 - CNPJ informado já está cadastrado
Constraint violation error	taxpayer_id: invalid Brazilian CNPJ number	400 Bad Request	400 - CNPJ (taxpayer_id) informado é inválido
Constraint violation error	email_address: must be a well-formed email address	400 Bad Request	400 - O email informado é inválido
Internal server error: valor inválido para o campo tax_regime	—	500 Internal Server Error	500 - O valor/texto informado para o campo não pertence a lista de valores esperada
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Listar Empresas Cadastradas

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Empresa por ID

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
entity not found for id id	—	404 Not Found	404 - Cadastro de Empresa não localizado
Invalid value for parameter named id	—	400 Bad Request	400 - Formato do parâmetro é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Atualizar Dados de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Internal server error: valor inválido para o campo foundation_date	—	500 Internal Server Error	400 - Um dos campos enviados está no formato inválido (video 'message')
Constraint violation error	email_address: must be a well-formed email address	400 Bad Request	400 - E-mail no formato inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
entity not found for id id	—	404 Not Found	404 - Empresa não localizada ou não associada ao Originador

Cadastrar Documento de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	type: must not be null	400 Bad Request	400 - Um campo obrigatório não foi enviado (vide 'detail')
—	—	400 Bad Request	400 - O campo 'type' é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Documentos de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Invalid value for parameter named id	—	400 Bad Request	400 - O ID da Empresa é inválido
entity not found for id id	—	404 Not Found	404 - O ID da Empresa não foi encontrado ou não pertence ao Originador
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Atualizar Documento de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	type: must not be null	400 Bad Request	400 - Um campo obrigatório não foi enviado (vide 'detail')
—	—	400 Bad Request	400 - O campo 'type' é inválido
Entity not found error	—	404 Not Found	404 - Arquivo não encontrado
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Excluir Documento de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Entity not found error	—	404 Not Found	404 - Arquivo não encontrado
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Fazer Download de Documento de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
entity not found for id id	—	404 Not Found	404 - Arquivo não encontrado
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Linhas de Crédito de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Solicitações de Empresa

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Configurar Assinatura

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Invalid request error	phone_verification_required: boolean is an invalid value	400 Bad Request	400 - Campo obrigatório inválido ou não enviado

Consultar Configurações de Assinatura

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Enviar Assinatura de Solicitação (Timestamp)

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Invalid value for parameter named id	—	400 Bad Request	400 - O parâmetro 'application_id' é inválido
Invalid value for parameter named id	—	400 Bad Request	400 - O parâmetro 'application_id' é inválido Copy
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Enviar Assinatura Física de Solicitação (Assinatura Externa)

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Assinaturas de Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
—	—	400 Bad Request	400 - O parâmetro 'application_id' não foi encontrado

Criar Simulação por Valor Desejado

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	requested_amount must not be null	400 Bad Request	400 - Campo de requested_amount é obrigatório
Invalid request error	schedule_type: mensal is an invalid value	400 Bad Request	400 - Campo de periodicidade é inválido
Constraint violation error	iofType: must not be null	400 Bad Request	400 - Campo de tipo de IOF é obrigatório
Invalid request error	iof_type: BUSINES is an invalid value	400 Bad Request	400 - Campo de tipo de IOF é inválido
Constraint violation error	numPayments: must not be null	400 Bad Request	400 - Campo número de parcelas é obrigatório
Constraint violation error	interestRate: must not be null	400 Bad Request	400 - Campo de taxa de juros é obrigatório
Constraint violation error	tac_amount is required	400 Bad Request	400 - Campo de TAC é obrigatório
Constraint violation error	financeFee: must not be null	400 Bad Request	400 - Campo de outras taxas é obrigatório
Constraint violation error	disbursementDate: Deve ser uma data no presente ou no futuro, firstPaymentDate: must be a future date	400 Bad Request	400 - Data de desembolso inválida, precisa ser uma data atual ou futura
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Criar Simulação por Valor Total das Parcelas

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	disbursementDate: Deve ser uma data no presente ou no futuro, firstPaymentDate: must be a future date	400 Bad Request	400 - Data de desembolso inválida, precisa ser uma data atual ou futura
Constraint violation error	total_amount_owed must not be null	400 Bad Request	400 - Campo de total_amount_owed é obrigatório
Invalid request error	schedule_type: MONTHLYY is an invalid value	400 Bad Request	400 - Campo de periodicidade é inválido
Invalid request error	iof_type: BUSINES is an invalid value	400 Bad Request	400 - Campo de tipo de IOF é inválido
Constraint violation error	iofType: must not be null	400 Bad Request	400 - Campo de tipo de IOF é obrigatório
Constraint violation error	numPayments: must not be null	400 Bad Request	400 - Campo número de parcelas é obrigatório
Constraint violation error	interestRate: must not be null	400 Bad Request	400 - Campo de taxa de juros é obrigatório
Constraint violation error	tac_amount is required	400 Bad Request	400 - Campo de TAC é obrigatório
Constraint violation error	financeFee: must not be null	400 Bad Request	400 - Campo de outras taxas é obrigatório
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Criar Simulação por Valor da Parcela

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	payment_value must not be null	400 Bad Request	400 - Campo de payment_value é obrigatório
Constraint violation error	disbursementDate: Deve ser uma data no presente ou no futuro	400 Bad Request	400 - Data de desembolso inválida, precisa ser uma data atual ou futura
Invalid request error	schedule_type: MONTHLYY is an invalid value	400 Bad Request	400 - Campo de periodicidade é inválido
Invalid request error	iof_type: BUSINES is an invalid value	400 Bad Request	400 - Campo de tipo de IOF é inválido
Constraint violation error	iofType: must not be null	400 Bad Request	400 - Campo de tipo de IOF é obrigatório
Constraint violation error	interestRate: must not be null	400 Bad Request	400 - Campo de taxa de juros é obrigatório
Constraint violation error	numPayments: must not be null	400 Bad Request	400 - Campo número de parcelas é obrigatório
Constraint violation error	tac_amount is required	400 Bad Request	400 - Campo de TAC é obrigatório
Constraint violation error	financeFee: must not be null	400 Bad Request	400 - Campo de outras taxas é obrigatório
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Criar Simulação por Valor Total Financiado

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	financed_amount must not be null	400 Bad Request	400 - Campo de financed_amount é obrigatório
Constraint violation error	disbursementDate: Deve ser uma data no presente ou no futuro	400 Bad Request	400 - Data de desembolso inválida, precisa ser uma data atual ou futura
Invalid request error	schedule_type: MONTHLYY is an invalid value	400 Bad Request	400 - Campo de periodicidade é inválido
Invalid request error	iof_type: PERSO is an invalid value	400 Bad Request	400 - Campo de tipo de IOF é inválido
Constraint violation error	iofType: must not be null	400 Bad Request	400 - Campo de tipo de IOF é inválido
Constraint violation error	interestRate: must not be null	400 Bad Request	400 - Campo de taxa de juros é obrigatório
Constraint violation error	numPayments: must not be null	400 Bad Request	400 - Campo número de parcelas é obrigatório
Constraint violation error	tac_amount is required	400 Bad Request	400 - Campo de TAC é obrigatório
Constraint violation error	financeFee: must not be null	400 Bad Request	400 - Campo de outras taxas é obrigatório
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Contrato de Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
UUID string too large	—	400 Bad Request	400 - O ID da Solicitação (application_id) excede o limite de caracteres de um UUID
entity not found for id id	—	404 Not Found	404 - O ID da Solicitação (application_id) informado não foi encontrado ou não possui permissão de consulta
Invalid UUID string	—	400 Bad Request	400 - O ID da Solicitação (application_id) é inválido

Consultar Contrato Assinado de Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
UUID string too large	—	400 Bad Request	400 - O ID da Solicitação (application_id) excede o limite de caracteres de um UUID
entity not found for id id	—	404 Not Found	404 - O ID da Solicitação (application_id) informado não foi encontrado ou não possui permissão de consulta
Invalid UUID string	—	400 Bad Request	400 - O ID da Solicitação (application_id) é inválido

Iniciar Tentativa de Desembolso

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
entity not found for id id	—	404 Not Found	404 - O ID da Solicitação (application_id) informado não foi encontrado ou não possui permissão de consulta
UUID string too large	—	400 Bad Request	400 - O ID da Solicitação (application_id) excede o limite de caracteres de um UUID
Invalid UUID string	—	400 Bad Request	400 - O ID da Solicitação (application_id) é inválido
Constraint violation error	cannot create disbursement attempt for application in status=CANCELED	400 Bad Request	400 - Não é possível uma tentativa de desembolso para uma Solicitação no status 'cancelada'
Constraint violation error	cannot create disbursement attempt for application in status=PENDING_SIGNATURE	400 Bad Request	400 - Não é possível uma tentativa de desembolso para uma Solicitação no status 'pendente de assinatura'

Listar Tentativas de Desembolso de Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
UUID string too large	—	400 Bad Request	400 - O ID da Solicitação (application_id) excede o limite de caracteres de um UUID
Invalid UUID string	—	400 Bad Request	400 - O ID da Solicitação (application_id) é inválido

Consultar Tentativa de Desembolso

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
entity not found for id id	—	404 Not Found	404 - O ID da Tentativa de Desembolso (disbursement_attempts_id) informado não foi encontrado ou não possui permissão de consulta
UUID string too large	—	400 Bad Request	400 - O ID da Tentativa de Desembolso (disbursement_attempts_id) excede o limite de caracteres de um UUID
Invalid UUID string	—	400 Bad Request	400 - O ID da Tentativa de Desembolso (disbursement_attempts_id) é inválido

Fazer Download de Comprovante de Desembolso

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
entity not found for id id	—	404 Not Found	404 - O ID da Solicitação (application_id) informado não foi encontrado ou não possui permissão de consulta
Disbursement receipt not found	—	400 Bad Request	400 - Recibo não encontrado ou o desembolso não foi realizado
Error during receipt data extraction. Check if the receipt matches the template standard	—	400 Bad Request	400 - Ocorreu um erro durante a extração dos dados para geração do comprovante ou o desembolso não foi realizado

Atualizar Ordem de Pagamento de Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Invalid UUID string	—	400 Bad Request	400 - O ID da ordem de pagamento é inváido

Criar Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
entity not found for id id	—	404 Not Found	400 - A Pessoa indicada não foi encontrada
Constraint violation error	issuer_disbursement_type: it's necessary to setup originator's external bank account when using ORIGINATOR for issuer disbursement type	400 Bad Request	400 - Para o tipo de desembolso 'ORIGINATOR' é obrigatório enviar os dados bancários externos (external_bank_account)
Constraint violation error	beneficiary_account: beneficiary account is required for this product	400 Bad Request	400 - O campo de conta bancária do beneficiário é obrigatório
Constraint violation error	disbursement_date: must not be null	400 Bad Request	400 - O campo de data de desembolso (disbursement_date) é obrigatório
Constraint violation error	funding: must not be null	400 Bad Request	400 - O campo de identificação do Fundo (funding) é obrigatório
Constraint violation error	product: must not be null	400 Bad Request	400 - O campo de identificação do Produto (product) é obrigatório
Constraint violation error	borrower: must not be null	400 Bad Request	400 - O campo de identificação do solicitante (borrower) é obrigatório
Constraint violation error	first_payment_date: must not be null	400 Bad Request	400 - O campo de data de primeiro pagamento (first_payment_date) é obrigatório
Constraint violation error	numPayments: must not be null	400 Bad Request	400 - O campo de número de parcelas (numPayments) é obrigatório
Constraint violation error	tacAmount: must not be null	400 Bad Request	400 - O campo de TAC (tac_amount) é obrigatório
Constraint violation error	interestRate: must not be null	400 Bad Request	400 - O campo de taxa de juros (interest_rate) é obrigatório
Constraint violation error	financeFee: must not be null	400 Bad Request	400 - O campo de 'outras taxas' (finance_fee) é obrigatório
Constraint violation error	requestedAmount: must not be null	400 Bad Request	400 - O campo de 'valor desejado'(requested_amount) é obrigatório
Constraint violation error	disbursementDate: must be a date in the present or in the future	400 Bad Request	400 - O campo de data de desembolso (disbursement_date) precisa ser uma data futura
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Criar Solicitação com Juros Pós-Fixados

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
entity not found for id id	—	404 Not Found	400 - A Pessoa indicada não foi encontrada
Constraint violation error	issuer_disbursement_type: it's necessary to setup originator's external bank account when using ORIGINATOR for issuer disbursement type	400 Bad Request	400 - Para o tipo de desembolso 'ORIGINATOR' é obrigatório enviar os dados bancários externos (external_bank_account)
Constraint violation error	beneficiary_account: beneficiary account is required for this product	400 Bad Request	400 - O campo de conta bancária do beneficiário é obrigatório
Constraint violation error	disbursement_date: must not be null	400 Bad Request	400 - O campo de data de desembolso (disbursement_date) é obrigatório
Constraint violation error	funding: must not be null	400 Bad Request	400 - O campo de identificação do Fundo (funding) é obrigatório
Constraint violation error	product: must not be null	400 Bad Request	400 - O campo de identificação do Produto (product) é obrigatório
Constraint violation error	borrower: must not be null	400 Bad Request	400 - O campo de identificação do solicitante (borrower) é obrigatório
Constraint violation error	first_payment_date: must not be null	400 Bad Request	400 - O campo de data de primeiro pagamento (first_payment_date) é obrigatório
Constraint violation error	numPayments: must not be null	400 Bad Request	400 - O campo de número de parcelas (numPayments) é obrigatório
Constraint violation error	tacAmount: must not be null	400 Bad Request	400 - O campo de TAC (tac_amount) é obrigatório
Constraint violation error	interestRate: must not be null	400 Bad Request	400 - O campo de taxa de juros (interest_rate) é obrigatório
Constraint violation error	financeFee: must not be null	400 Bad Request	400 - O campo de 'outras taxas' (finance_fee) é obrigatório
Constraint violation error	requestedAmount: must not be null	400 Bad Request	400 - O campo de 'valor desejado'(requested_amount) é obrigatório
Constraint violation error	disbursementDate: must be a date in the present or in the future	400 Bad Request	400 - O campo de data de desembolso (disbursement_date) precisa ser uma data futura
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Listar Solicitações

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
Invalid filter value: cannot be transformed to JSON object	—	400 Bad Request	Listar Solicitações

Cancelar Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
entity not found for id id	—	404 Not Found	404 - O ID da Solicitação (application_id) informado não foi encontrado ou não possui permissão de consulta
UUID string too large	—	400 Bad Request	400 - O ID da Solicitação (application_id) excede o limite de caracteres de um UUID
Invalid UUID string	—	400 Bad Request	400 - O ID da Solicitação (application_id) é inválido

Consultar Solicitação

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
entity not found for id id	—	404 Not Found	404 - O ID da Solicitação (application_id) informado não foi encontrado ou não possui permissão de consulta
UUID string too large	—	400 Bad Request	400 - O ID da Solicitação (application_id) excede o limite de caracteres de um UUID
Invalid UUID string	—	400 Bad Request	400 - O ID da Solicitação (application_id) é inválido

Listar Produtos Licenciados

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Produto

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
entity not found for id id	—	404 Not Found	400 - O ID de Produto informado não foi encontrado
UUID string too large	—	400 Bad Request	400 - O ID de Produto informado é inválido pois excede o tamanho de um UUID
Invalid UUID string	—	400 Bad Request	400 - O ID de Produto informado é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Consultar Campos Personalizáveis de Produto

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Listar Webhooks

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Cadastrar Webhook

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	url: must be a valid URL	400 Bad Request	400 - URL inválida. O campo 'url' precisa ser uma URL válida.
Constraint violation error	url: must not be null	400 Bad Request	400 - O campo de 'url' é obrigatório.
A webhook is already defined	—	400 Bad Request	400 - URL de webhook já está cadastrada
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Atualizar Webhook

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Constraint violation error	url: must be a valid URL	400 Bad Request	400 - URL inválida. O campo 'url' precisa ser uma URL válida.
Constraint violation error	url: must not be null	400 Bad Request	400 - O campo de 'url' é obrigatório.
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido

Excluir Webhook

Erro (Mensagem)	Detalhe (Campo/Regra)	Status HTTP	Indicativo
Invalid UUID string	—	400 Bad Request	400 - O ID do webhook informado é inválido
—	—	401 Unauthorized	401 - Consulta não autorizada ou auth token está inválido
—	—	500 Internal Server Error	500 - O ID do webhook informado não foi encontrado.