Guia da API
A API REST permite que você, ao fazer a integração com o Unico IDDocs, alcance seu objetivo. A API utiliza requisições e respostas no formato JSON e possui um sistema de autenticação baseado em JWT Bearer.
Principais Recursos
O IDDocs é comumente utilizado juntamente com IDUnico, com o objetivo de captura e validação de documentos durante a criação de uma transação biométrica.
- O método
GetReusableDocuments
lista todos os documentos disponíveis para compartilhamento da pessoa física dona do CPF informado. - O método
CreateProcess
cria um processo enviando as imagens e as informações da pessoa física. - O método
GetProcess
obtém o resultado do processo criado (É usado com o ID retornado no métodoCreateProcess
).
Obtenha um token OAuth válido;
Para efetuar requisições à API REST você precisa de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após a geração, o token de acesso deve ser enviado no header
de sua requisição, junto ao parâmetro Authorization
.
Ambientes
Ao iniciar a integração você receberá as credenciais do ambiente de homologação. Somente após o processo de testes e validação da integração é que você receberá as credenciais de produção.
Você deve apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo estão listadas informações de IP e Porta de homologação e produção:
- Ambiente de homologação:
https://api.id.uat.unico.app/
; - Ambiente de produção:
https://api.id.unico.app/
; - Porta padrão: 443.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.