Cadastrar dependentes

Use este endpoint para cadastrar as pessoas dependentes para um portador titular.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/portadores//dependentes' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "nome": "João da Silva", "nomeSocial": "João Gomes", "nomeMae": "Maria da Silva", "cpf": "91829438000", "dataNascimento": "2000-04-15", "sexo": "MASCULINO", "telefone": { "tipo": "CELULAR", "ramal": "4020", "area": "83", "telefone": "999999999", "receberSMS": false, "faturaDigital": false }, "grauParentesco": "PAI" }'

{ "idGrauParentesco": 5, "idDependente": 9999, "telefone": "83999999999", "cpf": "99999999999", "idClienteTitularAssociado": 999999, "nome": "PORTADOR DA FICCAO", "nomeSocial": "string", "dataNascimento": "1990-02-16", "sexo": "M", "nomeMae": "MAE DO PORTADOR", "status": "A" }

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

idPortador

integer <int64>

requerido

Identificador do portador titular.

Em caso de testes com a processadora Cards, utilize o valor 2001. Para testes com a processadora Dock, utilize o valor 2109.

Padrão:

2001

Exemplo:

2109

Parâmetros Header

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

Content-Type

string

opcional

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

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

opcional

One of

Processadora Cards

Processadora Dock

nome

string

requerido

Nome completo da pessoa dependente.

Exemplo:

João da Silva

nomeSocial

string

opcional

Nome social da pessoa dependente.

Exemplo:

João Gomes

nomeMae

string

requerido

Nome completo da mãe da pessoa dependente.

Exemplo:

Maria da Silva

cpf

string

opcional

Número do CPF da pessoa dependente, com 11 dígitos e sem pontuação.

Exemplo:

91829438000

dataNascimento

string <date>

requerido

Data de nascimento da pessoa dependente, no formato YYYY-MM-DD.

Exemplo:

2000-04-15

sexo

enum<string> | enum<null>

requerido

Sexo da pessoa dependente.

Valores permitidos:

MASCULINOFEMININOnull

Exemplo:

MASCULINO

telefone

object

opcional

grauParentesco

enum<string>

requerido

Grau de parentesco entre a pessoa dependente e a pessoa titular.

Valores permitidos:

PAIMAEFILHOIRMAOCONJUGEOUTROS

Exemplo:

FILHO

Examples

Respostas

🟢201Criado

application/json

Cadastrado.

Body

opcional

One of

Processadora Cards

Processadora Dock

idGrauParentesco

integer

opcional

Identificador do grau de parentesco entre a pessoa dependente e a pessoa titular.

Exemplo:

idDependente

integer

opcional

Identificador da pessoa dependente.

Exemplo:

9999

telefone

string

opcional

Número do telefone completo, com DDD, da pessoa dependente.

Exemplo:

83999999999

cpf

string

opcional

Número do CPF da pessoa dependente, com 11 dígitos e sem pontuação.

Exemplo:

99999999999

idClienteTitularAssociado

integer

opcional

Identificador do portador titular associado.

Exemplo:

999999

nome

string

opcional

Nome da pessoa dependente.

Exemplo:

PORTADOR DA FICCAO

nomeSocial

string

opcional

Nome social da pessoa dependente.

dataNascimento

string

opcional

Data de nascimento da pessoa dependente.

Exemplo:

1990-02-16

sexo

enum<string> | enum<null>

opcional

Sexo da pessoa dependente, sendo F para feminino e M para masculino.

Valores permitidos:

MFnull

Exemplo:

nomeMae

string

opcional

Nome da mãe da pessoa dependente.

Exemplo:

MAE DO PORTADOR

status

string

opcional

Status da pessoa dependente, onde A significa ativo.

Exemplo:

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor