Agenda de Signatários
Buscar contato por CPF
Busca um signatário na agenda pelo CPF. Retorna não-encontrado sem erro.
GET
Buscar contato por CPF
Busca rápida de um contato pelo CPF. Útil para verificar se um signatário já está na agenda ao preencher envelopes — se encontrado, preenche automaticamente nome, e-mail, telefone, etc.
Autenticação:
x-api-key no header. Também aceita Authorization: Bearer.
Parâmetros
string
required
CPF do contato (com ou sem máscara:
123.456.789-01 ou 12345678901).Respostas
boolean
Se o contato foi encontrado (
true ou false).object
Dados do contato, preenchido apenas se
found: true. Mesma estrutura de GET .../signer-contacts.Erros
Veja Autenticação e erros.- 400: CPF inválido (formato).
- 401: API key inválida.
found: false.
Exemplo
Importante
- Não-encontrado não é erro: a busca retorna 200 em ambos os casos (encontrado e não encontrado). Cheque
foundpara saber o resultado. - CPF com ou sem máscara: aceita ambos.
- Escopo por projeto: busca apenas na agenda do seu projeto.
Relacionado
GET .../signer-contacts— listar todosPOST .../signer-contacts— cadastrar novo