Cadastrar cliente

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/pessoa' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Maria Silva Sousa", "preferredName": "Maria Silva", "motherName": "Maria Sousa", "birthDate": "1964-04-01", "gender": "FEMININO", "document": "93967703043", "emancipatedMinor": false, "idNumber": "567899876432", "printedName": "Maria Sousa", "identityIssuingEntity": "SSP", "federativeUnit": "SP", "issuingDateIdentity": "2020-09-04", "idMaritalStatus": 1, "idProfession": "1", "idOccupationType": 1, "idNationality": 1, "fatherName": "João Silva", "bankNumber": 91, "branchNumber": 3, "accountNumber": "7667890", "email": "teste@email.com", "companyName": "Empresa Global", "idBusinessSource": 1, "idProduct": 1, "dueDate": "10", "incomeValue": 1000, "isPep": false, "isPepSince": "2019-09-09", "address": { "id": 1, "idAddressType": 1, "zipCode": "6800000", "street": "Rua da Amizade", "number": 22, "complement": "Apartamento 01", "neighborhood": "Centro", "city": "João Pessoa", "federativeUnit": "SP", "country": "Brasil", "mailingAddress": true }, "phone": { "id": 2, "idPhoneType": 1, "areaCode": "88", "number": "88999435670" }, "termsAndConditionsTokens": [ "e8b90ji7-09a8-428e-bab5-d6f271128b34" ], "deviceIdentification": { "fingerprint": "0191a530-0ed4-78bc-ade1-f89c281b332" } }'

{ "id": 2001, "name": "Maria Silva Sousa", "preferredName": "Maria Silva", "motherName": "Maria Sousa", "birthDate": "1964-04-01", "document": "93967703043", "fatherName": "João Silva", "gender": "FEMININO", "idNumber": "567899876432", "identityIssuingEntity": "SSP", "federativeUnit": "SP", "issuingDateIdentity": "2020-09-04", "idMaritalStatus": 1, "idProfession": "1", "idNationality": 1, "idOccupationType": 1, "branchNumber": 3, "accountNumber": "7667890", "email": "teste@email.com", "companyName": "Empresa Global", "idBusinessSource": 1, "idProduct": 1, "idAccount": 2001, "dueDate": 10, "printedName": "Maria Sousa", "incomeValue": 1000, "address": { "id": 1, "idAddressType": 1, "zipCode": "6800000", "street": "Rua da Amizade", "number": 22, "complement": "Apartamento 01", "neighborhood": "Centro", "city": "João Pessoa", "federativeUnit": "SP", "country": "Brasil", "mailingAddress": true }, "phone": { "id": 2, "idPhoneType": 1, "areaCode": "88", "number": "88999435670" }, "registrationId": "098u909", "status": "WAITING_DOCUMENTS", "isPep": true, "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 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

Parâmetros Bodyapplication/json

name

string

requerido

Nome.

Exemplo:

Maria Silva Sousa

preferredName

string

requerido

Nome de preferência.

Exemplo:

Maria Silva

motherName

string

requerido

Nome da mãe.

Exemplo:

Maria Sousa

birthDate

string

requerido

Data de nascimento.

Exemplo:

1964-04-01

gender

string

requerido

Gênero.

Exemplo:

FEMININO

document

string

requerido

Número da carteira de identidade nacional (CIN).

>= 11 Caracteres<= 11 Caracteres

Exemplo:

93967703043

Padrão de combinação:

[0-9]

emancipatedMinor

boolean

requerido

Indica se é pessoa menor de idade emancipada.

Padrão:

false

idNumber

string

opcional

Número da inscrição estadual.

<= 18 Caracteres

Exemplo:

567899876432

printedName

string

opcional

Nome impresso.

Exemplo:

Maria Sousa

identityIssuingEntity

string

requerido

Entidade emissora do documento.

Exemplo:

SSP

federativeUnit

string

opcional

Unidade federativa.

Exemplo:

issuingDateIdentity

string <date>

opcional

Data de emissão do documento.

Exemplo:

2020-09-04

idMaritalStatus

enum<integer>

requerido

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

requerido

Identificador da profissão.

<= 40 Caracteres

Exemplo:

idOccupationType

enum<integer>

requerido

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:

idNationality

enum<integer>

requerido

Identificador da nacionalidade.

1= Brasileiro(a)

2 = Estrangeiro(a)

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

Valores permitidos:

Exemplo:

fatherName

string

requerido

Nome do pai.

<= 100 Caracteres

Exemplo:

João Silva

bankNumber

integer <int32>

requerido

Número do banco.

Exemplo:

branchNumber

integer <int32>

requerido

Número da agência.

Exemplo:

accountNumber

string

requerido

Número da conta.

<= 15 Caracteres

Exemplo:

7667890

string

requerido

E-mail válido.

Exemplo:

teste@email.com

companyName

string

requerido

Nome da empresa.

Exemplo:

Empresa Global

idBusinessSource

integer <int32>

requerido

Identificador da origem comercial.

Exemplo:

idProduct

integer <int32>

requerido

Identificador do produto.

Exemplo:

dueDate

string

requerido

Data de vencimento.

Exemplo:

incomeValue

integer <int32>

requerido

Valor da reda.

Exemplo:

1000

isPep

boolean

requerido

Indica se é pessoa politicamente exposta.

Padrão:

false

isPepSince

string <date>

requerido

Data que a pessoa se tornou exposta politicamente.

Exemplo:

2019-09-09

address

object

opcional

Informações sobre endereço.

integer <int32>

opcional

Identificador do endereço.

Exemplo:

idAddressType

enum<integer>

opcional

Identificador do tipo de endereço.

1 = Próprio

2 = Alugado

3 = Financiado

4 = Empresa/espaço funcional

Valores permitidos:

1234

Exemplo:

zipCode

string

opcional

Código postal.

Exemplo:

6800000

street

string

opcional

Rua.

Exemplo:

Rua da Amizade

number

integer <int32>

opcional

Número.

Exemplo:

complement

string

opcional

Complemento.

Exemplo:

Apartamento 01

neighborhood

string

opcional

Bairro.

Exemplo:

Centro

city

string

opcional

Cidade.

Exemplo:

João Pessoa

federativeUnit

string

opcional

Unidade federativa.

Exemplo:

country

string

opcional

País.

Exemplo:

Brasil

mailingAddress

boolean

opcional

Indica se é o endereço postal.

Padrão:

true

phone

object

opcional

Informações sobre telefone.

integer <int32>

opcional

Identificador do telefone.

Exemplo:

idPhoneType

enum<integer>

opcional

Identificador do tipo de telefone.

1 = Residencial

2 = Contato

3 = Cônjuge

4 = Referência 1

5 = Referência 2

13 = Número de coleção

17 = Adicional

18 = Celular

Valores permitidos:

12345131718

Exemplo:

areaCode

string

opcional

Código de área.

Exemplo:

number

string

opcional

Número do telefone.

Exemplo:

88999435670

termsAndConditionsTokens

array[string]

requerido

Tokens dos termos e condições.

Exemplo:

["e8b90f67-09a8-428e-bab5-d6f271128b5b","0229ad42-2fef-41eb-ba10-d7ebca5f70c0"]

deviceIdentification

object

requerido

Informações do dispositivo de cadastro.

fingerprint

string

requerido

Digital do dispositivo.

Exemplo:

0191a530-0ed4-78bc-ade1-f89c281b332

Examples

Respostas

🟢200OK

application/json

Default

Body

integer <int32>

opcional

Identificador.

Exemplo:

2001

name

string

opcional

Nome.

Exemplo:

Maria Silva Sousa

preferredName

string

opcional

Nome de preferência.

Exemplo:

Maria Silva

motherName

string

opcional

Nome da mãe.

Exemplo:

Maria Sousa

birthDate

string

opcional

Data de nascimento.

Exemplo:

1964-04-01

document

string

opcional

Número da carteira de identidade nacional (CIN).

Exemplo:

93967703043

fatherName

string

opcional

Nome do pai.

Exemplo:

João Silva

gender

string

opcional

Gênero.

Exemplo:

FEMININO

idNumber

string

opcional

Número da inscrição estadual.

Exemplo:

567899876432

identityIssuingEntity

string

opcional

Entidade emissora do documento.

Exemplo:

SSP

federativeUnit

string

opcional

Unidade federativa.

Exemplo:

issuingDateIdentity

string

opcional

Data de emissão do documento.

Exemplo:

2020-09-04

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:

branchNumber

integer <int32>

opcional

Número da agência.

Exemplo:

accountNumber

string

opcional

Número da conta.

Exemplo:

7667890

string

opcional

E-mail.

Exemplo:

teste@email.com

companyName

string

opcional

Nome da empresa.

Exemplo:

Empresa Global

idBusinessSource

integer <int32>

opcional

Identificador da origem comercial.

Exemplo:

idProduct

integer <int32>

opcional

Identificador do produto.

Exemplo:

idAccount

integer <int32>

opcional

Identificador da conta.

Exemplo:

2001

dueDate

integer

opcional

Data de vencimento.

Exemplo:

printedName

string

opcional

Exemplo:

Maria Sousa

incomeValue

integer

opcional

Valor da renda.

Exemplo:

1000

address

object

opcional

Informações de endereço.

integer <int32>

opcional

Identificador do endereço.

Exemplo:

idAddressType

enum<integer>

opcional

Identificador do tipo de endereço.

1 = Próprio

2 = Alugado

3 = Financiado

4 = Empresa/espaço funcional

Valores permitidos:

1234

Exemplo:

zipCode

string

opcional

Código postal.

Exemplo:

6800000

street

string

opcional

Rua.

Exemplo:

Rua da Amizade

number

integer <int32>

opcional

Número.

Exemplo:

complement

string

opcional

Complemento.

Exemplo:

Apartamento 01

neighborhood

string

opcional

Bairro.

Exemplo:

Centro

city

string

opcional

Cidade.

Exemplo:

João Pessoa

federativeUnit

string

opcional

Unidade federativa.

Exemplo:

country

string

opcional

País.

Exemplo:

Brasil

mailingAddress

boolean

opcional

Indica se é endereço postal.

Padrão:

true

phone

object

opcional

Informações de telefone.

integer <int32>

opcional

Identificador do telefone.

Exemplo:

idPhoneType

enum<integer>

opcional

Identificador do tipo de telefone.

1 = Residencial

2 = Contato

3 = Cônjuge

4 = Referência 1

5 = Referência 2

13 = Número de coleção

17 = Adicional

18 = Celular

Valores permitidos:

12345131718

Exemplo:

areaCode

string

opcional

Código de área.

Exemplo:

number

string

opcional

Número do telefone.

Exemplo:

88999435670

registrationId

string

opcional

Código de cadastro da pessoa portadora.

Exemplo:

098u909

status

enum<string>

opcional

Status do cadastro.

WAITING_DOCUMENTS = aguardando documentos

ACTIVE = ativo

DECLINED = negado

Valores permitidos:

WAITING_DOCUMENTSACTIVEDECLINED

Exemplo:

ACTIVE

isPep

boolean

opcional

Indica se é pessoa política.

Padrão:

true

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