Consulta de pessoa
Consulta a pessoa, através do documento (CFP/CNPJ) ou e-mail, pelo um deles deve ser informado como parâmetro QUERY STRING. Caso documento/e-mail não seja vinculado a uma pessoa, iremos retornar pessoa não encontrada.
GET api/pessoa?email=<email>
GET api/pessoa?documento=<documento>
HEADERS
CHAVE |
VALOR |
DESCRIÇÃO |
OBRIGATÓRIO |
Accept |
application/vnd.linkc.com.br; version=1 | Versão da API. | SIM |
Authorization |
Bearer <TOKEN> |
Token obtido na autenticação |
SIM |
Content-Type |
application/json |
Tipo de conteúdo do request |
SIM |
PARÂMETROS QUERY STRING
CHAVE |
DESCRIÇÃO |
OBRIGATÓRIO |
documento | cpf/cnpj válido | SIM |
email válido | SIM |
RETORNO EM CASO DE SUCESSO (200 – OK)
{
"pessoas" : [
{
"id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
"nome": "MARIA VITÓRIA OLIVEIRA",
"email": "teste@teste.com",
"documento": "64454846626",
"tipo": "PESSOA FÍSICA",
"logradouro": "RUA TESTE",
"numero": "1",
"complemento": "SL 03",
"bairro": "BAIRRO",
"cidade": "CAMPINAS",
"uf": "SP",
"cep": "11111111",
"telefone": "11999999999"
}
]
}
OUTROS RETORNOS
CÓDIGO HTTP |
DESCRIÇÃO |
400 |
Caso os parâmetros passados estejam incorretos. |
401 |
Caso as credenciais sejam inválidas. |
404 |
Caso a pessoa não seja encontrada. |