Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Beneficiary

Consulta do beneficiário.

get/beneficiary/{id}

Path parameters

idstring required

Id do beneficiario.

Response

Success

idstring

Propriedade Id Identificador único gerado automaticamente.

documentType'CNPJ' | 'CPF' | 'ESTRANGEIRO'

Tipo de Documento.<p>Values:</p><ul><li><i>CNPJ</i> - CNPJ.</li><li><i>CPF</i> - CPF.</li><li><i>ESTRANGEIRO</i> - Estrangeiro.</li></ul>

documentstring nullable

Propriedade Document CPF ou CNPJ do beneficiário.

namestring nullable

Propriedade Name Nome ou Razão Social do beneficiário.

status'APTO' | 'EM_ANALISE' | 'INAPTO' | 'SEM_CADASTRO' | 'PROCESSAMENTO' | 'REJEITADO'

Valores BeneficiaryStatus Situação do beneficiário.<p>Values:</p><ul><li><i>APTO</i> - Apto.</li><li><i>EM_ANALISE</i> - Em Análise.</li><li><i>INAPTO</i> - Inapto.</li><li><i>SEM_CADASTRO</i> - Sem Cadastro.</li><li><i>PROCESSAMENTO</i> - Processamento.</li><li><i>REJEITADO</i> - Rejeitado.</li></ul>

createdstring date-time

Propriedade Created Data de inclusão.

updatedstring date-time nullable

Propriedade Updated Data de alteração.

Example response

{
  "id": "662699d67b3a39e56b592db0",
  "documentType": "CNPJ",
  "document": "51236721000136",
  "name": "Nome ou Razão Social do beneficiário",
  "status": "APTO"
}