Para você testar aqui no DevCenter!
Passo 1. Obter token
Para este método você precisa das credenciais: username e password.
O token gerado no response deve ser utilizado no próximo passo.
Passo 2. Criar ticket e definir a jornada
Para este método, você deve usar o token gerado no response do passo anterior.
Além do token, você deve informar os parâmetros abaixo e os headers.
| body params | descrição |
|---|---|
| externalId | código de identificação externa do integrador (empresa), como: ID da transação do cliente, número nota fiscal, contrato, etc.; |
| userDocumentNumber | número do CPF do usuário; |
| name | nome e sobrenome do usuário; |
| birthDate | data de nascimento do usuário; |
| attrs | trata-se dos atributos da transação do serviço que será executado. |
Case sensitive
Os dados utilizados nos endpoints da Certiface API são case sensitive. Por favor, não realize alterações nos caracteres para qualquer uma das operações que serão realizadas, especialmente de campos de identificação, como o ticket, appkey e credenciais.
Atente-se!
O ticket gerado no response deve ser utilizado junto ao token nos demais passos.
Passo 3. Gerar appkey
Além do token, você deve informar o ticket gerado no response do passo 2 e os headers.
| body params | descrição |
|---|---|
| ticket | número do ticket gerado na etapa criar ticket. |
Passo 4. Processar dados da transação
Além do token, você deve informar os parâmetros abaixo e os headers.
| body params | descrição |
|---|---|
| ticket | número do ticket gerado na etapa criar ticket; |
| appkey | appkey para execução da jornada; chave de acesso frontend; |
| photo | foto (selfie) do cliente em formato base64; |
| documentImages | Lista de imagens em base64 do documento; obrigatório para ferramentas Doc Core. |
Passo 5. Consultar resultado do processamento
Informe o token, o ticket e os headers.
Para detalhes do response deste request, acesse o documento de descrição dos objetos, códigos e score de risco.