API docs by Redocly

Customer Data Service (1.0.0)

Introdução

CDS foi desenvolvido para lidar com dados de pessoas em forma de micro serviço, neste projeto contamos com Mysql e Redis. Seu desenvolvimento inicial foi destinado para Idea Maker.

Autenticação

O serviço conta com a seguinte forma de autenticação:

  • Basic Auth

basic_auth

Suponhamos que sua chave de API seja minha-chave-de-api. Você deverá enviar uma string codificada em Base64 no seguinte formato :minha-chave-de-api, mantenha o : (dois pontos) na string. Lembre-se de passar login e password no basic! O resultado final será algo parecido com o conteúdo abaixo.

Authorization: Basic Om1pbmhhLWNoYXZlLWRlLWFwaQ==
Security Scheme Type: HTTP
HTTP Authorization Scheme: basic

Search

Pesquisa por informações gerais.

Busca informações

Rota para buscar informações de pessoa

Authorizations:
basic_auth
Request Body schema: application/json

ATENÇÃO: Hoje a rota só funciona para CPF.

type
required
string
Enum: "cpf" "cnpj"

Tipo do documento a ser pesquisado

document
required
string

Documento da pessoa ou empresa a ser pesquisado

Responses

Request samples

Content type
application/json
{
  • "type": "cpf",
  • "document": 11111111111
}

Response samples

Content type
application/json
{
  • "document": "11111111111",
  • "type": "cpf",
  • "email": "testes@hotmail.com",
  • "phone": {
    },
  • "birthday": "2022-03-20T00:00:00.000Z",
  • "gender": "M",
  • "name": "Josildo da Silva Neto",
  • "state": "PR",
  • "address": {
    }
}