Listar informações do portador

Use este endpoint para listar as informações pessoais do usuário de uma conta ativa.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/contas/individuo/' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json'

{ "id": 9917545, "idRegistration": "5a999999-157e-4252-z3dz-249z7z5z9999", "idNumber": "6537265", "name": "Seiya de Pegaso", "document": "03967703045", "birthDate": "1992-12-14T12:05:39.502Z", "gender": "M", "identityIssuingEntity": "SSP", "federativeUnit": "SP", "issuingDateIdentity": "2000-02-01", "motherName": "Saori Kido", "fatherName": "Matsumada Kido", "idMaritalStatus": 1, "idProfession": "Engenharia", "idNationality": 1, "idOccupationType": 1, "bankNumber": 0, "branchNumber": 0, "accountNumber": "00000", "email": "example@example.com", "companyName": "Cavaleiros CO", "incomeValue": "1000", "status": "WAITING_DOCUMENTS", "statusSPD": [ { "statusId": 1, "name": "Aguardando documentos", "reason": "Aguardando documentos", "createDate": "2022-12-14T12:05:39.502Z" } ], "isPep": false, "isPepSince": "2019-09-09" }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

idConta

integer <int32>

requerido

Identificador da conta.

Exemplo:

2001

Parâmetros Header

string

requerido

Tipo de conteúdo aceito.

Exemplo:

*/*

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Respostas

🟢200OK

application/json

Body

integer <int32>

opcional

Identificador da conta.

Exemplo:

9917545

idRegistration

string

opcional

Código de cadastro.

Exemplo:

5a999999-157e-4252-z3dz-249z7z5z9999

idNumber

string

opcional

Número do registro civil (RG) do portador.

<= 18 Caracteres

Exemplo:

6537265

name

string

opcional

Nome.

Exemplo:

Seiya de Pegaso

document

string

opcional

Documento oficial.

Exemplo:

03967703045

birthDate

string <date-time>

opcional

Data de nascimento.

Exemplo:

1999-12-14T12:05:39.502Z

gender

enum<string>

opcional

Gênero.

Valores permitidos:

Exemplo:

identityIssuingEntity

string

opcional

Entidade emissora do documento.

<= 6 Caracteres

Exemplo:

SSP

federativeUnit

string

opcional

Unidade federativa.

Exemplo:

issuingDateIdentity

string

opcional

Data de emissão do documento.

Exemplo:

2000-02-01

motherName

string

opcional

Nome da mãe.

<= 80 Caracteres

Exemplo:

Saori Kido

fatherName

string

opcional

Nome do pai.

<= 80 Caracteres

Exemplo:

Matsumada Kido

idMaritalStatus

enum<integer>

opcional

Identificador do estado civil.

1 = Pessoa solteira

2 = Pessoa casada

3 = Em separação judicial

4 = Pessoa viúva

5 = Pessoa divorciada

6 = Em união estável

7 = Pessoa separada

Valores permitidos:

1234567

Exemplo:

idProfession

string

opcional

Identificador da profissão.

Exemplo:

idNationality

enum<integer>

opcional

Identificador da nacionalidade.

1= Brasileiro(a)

2 = Estrangeiro(a)

Se documento cadastrado for RNE_FRONT e RNE_VERSE, idNationality = 2.

Valores permitidos:

Exemplo:

idOccupationType

enum<integer>

opcional

Identificador do tipo de ocupação.

1 = Pessoa aposentada

2 = Com vínculo empregatício

3 = Profissional liberal

4 = Profissional autônomo(a)

5 = Outros

Valores permitidos:

12345

Exemplo:

bankNumber

integer <int32>

opcional

Número do banco.

Exemplo:

branchNumber

integer <int32>

opcional

Número da agência.

Exemplo:

accountNumber

string

opcional

Número da conta.

Exemplo:

000098

string

opcional

E-mail válido.

Exemplo:

example@example.com

companyName

string

opcional

Nome da empresa.

Exemplo:

Cavaleiros CO

incomeValue

string

opcional

Valor do salário.

Exemplo:

1000

status

enum<string>

opcional

Status do cadastro da conta.

WAITING_DOCUMENTS = aguardando documentação

WAITING_ANALYSIS = aguardando análise

ACTIVE = conta ativa

DECLINED = conta recusada

CANCELED = conta cancelada

Valores permitidos:

WAITING_DOCUMENTSWAITING_ANALYSISACTIVEDECLINEDCANCELED

Exemplo:

WAITING_DOCUMENTS

statusSPD

array [object {4}]

opcional

Status do Sistema de Proteção Dock.

statusId

integer <int32>

opcional

Identificador do status.

Exemplo:

name

string

opcional

Nome do status no Sistema de Proteção Dock.

Exemplo:

Aguardando documentos

reason

string

opcional

Motivo para o status no Sistema de Proteção Dock.

Exemplo:

Aguardando documentos

createDate

string <date-time>

opcional

Data de criação do status no Sistema de Proteção Dock.

Exemplo:

2022-12-14T12:05:39.502Z

isPep

boolean

opcional

Indica se é uma pessoa politicamente exposta.

Padrão:

false

isPepSince

string <date>

opcional

Data que a pessoa se tornou exposta politicamente.

Exemplo:

2019-09-09

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor