API Docs Início Documentação Referência de API Copiar para LLM
GET/v1/NaturalPerson/{id}
Crédito · Pessoas

Lista uma pessoa física por id

Consulta Natural Person pelo identificador informado na rota.

Visão geral

Lista uma pessoa física por id

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

Request

Parâmetros

NomeEmTipoObrigatórioDescriçãoExemplo
idpathstring (uuid)obrigatório3fa85f64-5717-4562-b3fc-2c963f66afa6

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
idstring (uuid)opcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring (date-time)opcional"2025-08-11T13:45:00Z"
createdByobjetoopcionalobjeto — ver detalhe abaixo{ … }
tenantstringopcional"texto"
tenantDisplaystringopcional"texto"
updatedAtstring (date-time)opcional"2025-08-11T13:45:00Z"
updatedByobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerUserobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcionalobjeto — ver detalhe abaixo{ … }
registrationNumberstringopcional"12345678909"
namestringopcional"Fulano de Tal"
nationalitystringopcional"texto"
pepbooleanopcionaltrue
addressobjetoopcionalobjeto — ver detalhe abaixo{ … }
birthDatestring (date-time)opcional"2025-08-11T13:45:00Z"
civilStatusstringopcional"texto"
civilStatusDisplaystringopcional"texto"
genderstringopcional"texto"
genderDisplaystringopcional"texto"
documentTypestringopcional"texto"
documentTypeDisplaystringopcional"texto"
documentNumberstringopcional"texto"
documentIssuerstringopcional"texto"
documentDatestring (date-time)opcional"2025-08-11T13:45:00Z"
documentExpirationstring (date-time)opcional"2025-08-11T13:45:00Z"
phonestringopcional"11987654321"
phoneExtensionstringopcional"11987654321"
phone2stringopcional"11987654321"
phone2Extensionstringopcional"11987654321"
emailstringopcional"cliente@exemplo.com.br"
mothersNamestringopcional"Fulano de Tal"
fathersNamestringopcional"Fulano de Tal"
placeOfBirthCountrystringopcional"texto"
placeOfBirthStatestringopcional"texto"
typeOfResidencestringopcional"texto"
typeOfResidenceDisplaystringopcional"texto"
hasDependentsbooleanopcionaltrue
totalDependentsintegeropcional0
between7And15YearsOldintegeropcional0
upTo6YearsOldintegeropcional0
over15YearsOldintegeropcional0
workplacestringopcional"texto"
workplaceDisplaystringopcional"texto"
workplaceCompanyRegistrationNumberstringopcional"texto"
employeeNumberstringopcional"texto"
occupationstringopcional"texto"
natureOfOccupationstringopcional"texto"
natureOfOccupationDisplaystringopcional"texto"
commercialPhonestringopcional"11987654321"
commercialPhoneExtensionstringopcional"11987654321"
netSalaryinteger (int64)opcional0
otherIncomeinteger (int64)opcional0
totalIncomeinteger (int64)opcional0
admissionDatestring (date-time)opcional"2025-08-11T13:45:00Z"
commercialPhone2stringopcional"11987654321"
commercialPhone2Extensionstringopcional"11987654321"
commercialAddressobjetoopcionalobjeto — ver detalhe abaixo{ … }
economicActivityCodeIdstring (uuid)opcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
economicActivityCodeobjetoopcionalobjeto — ver detalhe abaixo{ … }
economicActivityCodeDisplaystringopcional"texto"
spouseIndividualRegistrationNumberstringopcional"texto"
spouseDocumentTypestringopcional"texto"
spouseDocumentTypeDisplaystringopcional"texto"
spouseDocumentNumberstringopcional"texto"
spouseDocumentIssuerstringopcional"texto"
spouseDocumentDatestring (date-time)opcional"2025-08-11T13:45:00Z"
spouseDocumentExpirationstring (date-time)opcional"2025-08-11T13:45:00Z"
spouseNamestringopcional"Fulano de Tal"
spouseWorkplacestringopcional"texto"
spouseOccupationstringopcional"texto"
spouseCommercialPhonestringopcional"11987654321"
spouseCommercialPhoneExtensionstringopcional"11987654321"
spouseBirthDatestring (date-time)opcional"2025-08-11T13:45:00Z"
spouseNetSalarynumber (double)opcional1000
spouseOtherIncomenumber (double)opcional1000
spouseTotalIncomenumber (double)opcional1000
allowContactWhatsAppbooleanopcionaltrue
allowUpdatesWhatsAppbooleanopcionaltrue
assetsarray de objetoopcionalobjeto — ver detalhe abaixo[ … ]
uploadsarray de objetoopcionalobjeto — ver detalhe abaixo[ … ]
bankAccountsarray de objetoopcionalobjeto — ver detalhe abaixo[ … ]
personCreditStatusobjetoopcionalobjeto — ver detalhe abaixo{ … }
riskRatingstringopcional"texto"
healthDeclarationstringopcionalDeclaração de Saúde"texto"
departmentstringopcionalDepartamento"texto"
socialNamestringopcionalNome Social"Fulano de Tal"

Detalhe de createdBy

CampoTipoObrigatórioDescriçãoValoresExemplo
userIdstringopcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
registrationNumberstringopcional"12345678909"
userIdDisplaystringopcional"texto"
tenantDisplaystringopcional"texto"
tenantstringopcional"texto"
tenantNamestringopcional"Fulano de Tal"

Detalhe de ownerGroup

CampoTipoObrigatórioDescriçãoValoresExemplo
groupDisplaystringopcional"texto"
groupIdstringopcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
tenantDisplaystringopcional"texto"
tenantNamestringopcional"Fulano de Tal"

Detalhe de address

CampoTipoObrigatórioDescriçãoValoresExemplo
addressNamestringopcional"Fulano de Tal"
zipCodestringopcional"01310930"
citystringopcional"texto"
ufstringopcional"texto"
ufDisplaystringopcional"texto"
districtstringopcional"texto"
numberstringopcional"texto"
complementstringopcional"texto"

Detalhe de economicActivityCode

CampoTipoObrigatórioDescriçãoValoresExemplo
codestringopcional"texto"
descriptionstringopcional"texto"

Detalhe de assets

CampoTipoObrigatórioDescriçãoValoresExemplo
idstring (uuid)opcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring (date-time)opcional"2025-08-11T13:45:00Z"
createdByobjetoopcionalobjeto — ver detalhe abaixo{ … }
tenantstringopcional"texto"
tenantDisplaystringopcional"texto"
updatedAtstring (date-time)opcional"2025-08-11T13:45:00Z"
updatedByobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerUserobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcionalobjeto — ver detalhe abaixo{ … }
assetTypestringopcional"texto"
assetTypeDisplaystringopcional"texto"
descriptionstringopcional"texto"
registerNumberstringopcional"texto"
estimatedValuenumber (double)opcional1000
settledbooleanopcionaltrue

Detalhe de uploads

CampoTipoObrigatórioDescriçãoValoresExemplo
idstring (uuid)opcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring (date-time)opcional"2025-08-11T13:45:00Z"
createdByobjetoopcionalobjeto — ver detalhe abaixo{ … }
tenantstringopcional"texto"
tenantDisplaystringopcional"texto"
updatedAtstring (date-time)opcional"2025-08-11T13:45:00Z"
updatedByobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerUserobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcionalobjeto — ver detalhe abaixo{ … }
fileNamestringopcional"Fulano de Tal"
fileTypestringopcional"texto"
displayNamestringopcional"Fulano de Tal"
documentDatestring (date-time)opcionalData do próprio documento (emissão/referência), distinta da data do upload (CreatedAt). Retornada para qualquer tipo de documento; nula quando não foi informada no envio."2025-08-11T13:45:00Z"
tempUrlstringopcional"https://exemplo.com.br/callback"
tempGetUrlstringopcional"https://exemplo.com.br/callback"
tempPutUrlstringopcional"https://exemplo.com.br/callback"

Detalhe de bankAccounts

CampoTipoObrigatórioDescriçãoValoresExemplo
idstring (uuid)opcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring (date-time)opcional"2025-08-11T13:45:00Z"
createdByobjetoopcionalobjeto — ver detalhe abaixo{ … }
tenantstringopcional"texto"
tenantDisplaystringopcional"texto"
updatedAtstring (date-time)opcional"2025-08-11T13:45:00Z"
updatedByobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerUserobjetoopcionalobjeto — ver detalhe abaixo{ … }
ownerGroupobjetoopcionalobjeto — ver detalhe abaixo{ … }
bankCodestringopcional"texto"
bankCodeCompeintegeropcional0
bankCodeDisplaystringopcionalNome de exibição do Código do banco"texto"
bankIspbinteger (int64)opcionalCódigo ISPB do banco0
accountstringopcional"texto"
accountDigitstringopcional"texto"
agencystringopcional"texto"
agencyDigitstringopcional"texto"
typestringopcional"texto"
typeDisplaystringopcionalNome de exibição do tipo da Conta Bancaria"texto"
jointAccountbooleanopcionaltrue
operationTypeValuestringopcionalTED, PIX"texto"
pixKeyTypeValuestringopcionaltipo chave pix"texto"
keyPixstringopcionalchave pix"texto"

Detalhe de personCreditStatus

CampoTipoObrigatórioDescriçãoValoresExemplo
registrationNumberstringopcional"12345678909"
validUntilstring (date-time)opcional"2025-08-11T13:45:00Z"
statusstringopcional"texto"
reasonstringopcional"texto"
detailedReasonstringopcional"texto"
approvedLimitinteger (int64)opcional0

Exemplo de resposta

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2025-08-11T13:45:00Z",
  "createdBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenant": "texto",
    "tenantName": "Fulano de Tal"
  },
  "tenant": "texto",
  "tenantDisplay": "texto",
  "updatedAt": "2025-08-11T13:45:00Z",
  "updatedBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenant": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenant": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupDisplay": "texto",
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "registrationNumber": "12345678909",
  "name": "Fulano de Tal",
  "nationality": "texto",
  "pep": true,
  "address": {
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "texto",
    "ufDisplay": "texto",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "birthDate": "2025-08-11T13:45:00Z",
  "civilStatus": "texto",
  "civilStatusDisplay": "texto",
  "gender": "texto",
  "genderDisplay": "texto",
  "documentType": "texto",
  "documentTypeDisplay": "texto",
  "documentNumber": "texto",
  "documentIssuer": "texto",
  "documentDate": "2025-08-11T13:45:00Z",
  "documentExpiration": "2025-08-11T13:45:00Z",
  "phone": "11987654321",
  "phoneExtension": "11987654321",
  "phone2": "11987654321",
  "phone2Extension": "11987654321",
  "email": "cliente@exemplo.com.br",
  "mothersName": "Fulano de Tal",
  "fathersName": "Fulano de Tal",
  "placeOfBirthCountry": "texto",
  "placeOfBirthState": "texto",
  "typeOfResidence": "texto",
  "typeOfResidenceDisplay": "texto",
  "hasDependents": true,
  "totalDependents": 0,
  "between7And15YearsOld": 0,
  "upTo6YearsOld": 0,
  "over15YearsOld": 0,
  "workplace": "texto",
  "workplaceDisplay": "texto",
  "workplaceCompanyRegistrationNumber": "texto",
  "employeeNumber": "texto",
  "occupation": "texto",
  "natureOfOccupation": "texto",
  "natureOfOccupationDisplay": "texto",
  "commercialPhone": "11987654321",
  "commercialPhoneExtension": "11987654321",
  "netSalary": 0,
  "otherIncome": 0,
  "totalIncome": 0,
  "admissionDate": "2025-08-11T13:45:00Z",
  "commercialPhone2": "11987654321",
  "commercialPhone2Extension": "11987654321",
  "commercialAddress": {
    "addressName": "Fulano de Tal",
    "zipCode": "01310930",
    "city": "texto",
    "uf": "texto",
    "ufDisplay": "texto",
    "district": "texto",
    "number": "texto",
    "complement": "texto"
  },
  "economicActivityCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "economicActivityCode": {
    "code": "texto",
    "description": "texto"
  },
  "economicActivityCodeDisplay": "texto",
  "spouseIndividualRegistrationNumber": "texto",
  "spouseDocumentType": "texto",
  "spouseDocumentTypeDisplay": "texto",
  "spouseDocumentNumber": "texto",
  "spouseDocumentIssuer": "texto",
  "spouseDocumentDate": "2025-08-11T13:45:00Z",
  "spouseDocumentExpiration": "2025-08-11T13:45:00Z",
  "spouseName": "Fulano de Tal",
  "spouseWorkplace": "texto",
  "spouseOccupation": "texto",
  "spouseCommercialPhone": "11987654321",
  "spouseCommercialPhoneExtension": "11987654321",
  "spouseBirthDate": "2025-08-11T13:45:00Z",
  "spouseNetSalary": 1000,
  "spouseOtherIncome": 1000,
  "spouseTotalIncome": 1000,
  "allowContactWhatsApp": true,
  "allowUpdatesWhatsApp": true,
  "assets": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "assetType": "texto",
      "assetTypeDisplay": "texto",
      "description": "texto",
      "registerNumber": "texto",
      "estimatedValue": 1000,
      "settled": true
    }
  ],
  "uploads": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "fileName": "Fulano de Tal",
      "fileType": "texto",
      "displayName": "Fulano de Tal",
      "documentDate": "2025-08-11T13:45:00Z",
      "tempUrl": "https://exemplo.com.br/callback",
      "tempGetUrl": "https://exemplo.com.br/callback",
      "tempPutUrl": "https://exemplo.com.br/callback"
    }
  ],
  "bankAccounts": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenant": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "bankCode": "texto",
      "bankCodeCompe": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "account": "texto",
      "accountDigit": "texto",
      "agency": "texto",
      "agencyDigit": "texto",
      "type": "texto",
      "typeDisplay": "texto",
      "jointAccount": true,
      "operationTypeValue": "texto",
      "pixKeyTypeValue": "texto",
      "keyPix": "texto"
    }
  ],
  "personCreditStatus": {
    "registrationNumber": "12345678909",
    "validUntil": "2025-08-11T13:45:00Z",
    "status": "texto",
    "reason": "texto",
    "detailedReason": "texto",
    "approvedLimit": 0
  },
  "riskRating": "texto",
  "healthDeclaration": "texto",
  "department": "texto",
  "socialName": "Fulano de Tal"
}

Códigos de retorno

CódigoSignificadoDetalhe do contrato
200Requisição bem-sucedida.Success

Exemplos

curl -X GET "{{baseUrl}}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();
const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/NaturalPerson/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Guia de importação: Como importar no Postman · Todos os downloads: Downloads