Descrição Response Serviços Executados

Aqui você vai encontrar todos os campos e descrição do Response dos serviços executados; para response status 200.

As duas primeiras tabelas abaixo serão retornadas independente do serviço que vai ser executado:

Objeto	Tipo	Descrição
id	string	Identificador do resultado retornado
ticket	string	Ticket relacionado ao resultado
externalId	string	Id passado pelo cliente na abertura do ticket
ticketStatus	string	Status do ticket (active, done, awaiting, inactive, error, retry)
reasonInvalidation	string	Motivo da invalidação do ticket, caso tenha sido invalidado, segue abaixo tabela com detalhes (Tabela Reason Invalidation)
createAt	string	Data e hora da abertura do ticket
updateAt	string	Data e hora da ultima inserção no result

Tabela do objeto "Reason Invalidation" (array)

Objeto	Tipo	Descrição
type	string	Motivo da invalidação (INVALID_WORKFLOW, BUSINESS_ROLES e outros)
description	string	Descrição com maiores detalhes do motivo da invalidação

Response Prova de Vida

Quando o serviço LIVENESS (Prova de Vida) é executado, os seguintes campos são retornados:

services (array)

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Prova de Vida
createAt	string	Data do processamento da Prova de Vida (Formato isoUtcDateTime: yyyy-mm-dd'T'HH:MM:ss:l'Z')
documentNumber	string	Número do documento do cliente
name	string	Nome do cliente
birth	string	Data de nascimento do cliente
image	string	Link de acesso a imagem enviada
codeId	string	Código da Prova de Vida conforme Tabela abaixo
valid	string	Resultado do teste de vivacidade

Tabela do objeto "codeId"

codeId	Descrição
1.0	Prova de Vida Aprovada
300.1	Prova de Vida Reprovada (face não identificada; necessário retentativa)
300.2	Prova de Vida Reprovada (usuário bloqueado; retentativa não disponível)

Response Bureau

Response Bureau para Onboarding

Quando o serviço BUREAU para Onboarding (Cadastro) é executado, os seguintes campos são retornados:

services (array)

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Bureau
createAt	string	Data e hora da execução do serviço
image	string	URL/base64 utilizado na execução do serviço

Response Bureau para Transacional

Quando o serviço BUREAU para transacional (FaceToken) é executado, os seguintes campos são retornados:

services (array)

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Bureau
createAt	string	Data e hora da execução do serviço
code	string	code da execução do serviço, segue abaixo tabela com detalhes (Tabela Code)
approved	string	True indica que a transação foi aprovada com baixa possibilidade de fraude; False indica alta possibilidade de fraude ou erro.
score	string	Score de biometria. Float de 0 a 1.
known	string	True indica que o usuário já possui cadastro sólido na base; False indica cadastro recente ou com baixa confiança.
firstCertification	string	Indica se trata-se da primeira certificação.
image	string	URL/base64 utilizado na execução do serviço

Tabela do objeto "code"

codigo	Descrição
201	Cadastro com sucesso.
202	Cadastro com pendência.
212	Cadastro com pendência e similares restritos.
203	Certificação positiva.
204	Certificação negativa.
401	Falha na qualidade da imagem da face.
402	Cadastro desabilitado.
501	Falha ao cadastrar.

Response Serpro

Quando o serviço SERPRO é executado os seguintes campos são retornados:

services (array)

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Serpro
createAt	string	Data e hora da execução do serviço
image	string	URL/base64 utilizado na execução do serviço

Response Classe de Risco

Quando o serviço RISK CLASS (classe de risco) é executado, os seguintes campos são retornados:

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Risk Class
createAt	string	Data e hora da execução do serviço
risk	string	É o conceito referente ao score da Classe de Risco (Tabela classe de risco)
score	string	Recomendação de acordo com a Classe de Risco (Tabela classe de risco)

Tabela conceito "Classe de Risco"

A classe de risco está classificada da seguinte forma:

Objeto "risk"	Score de risco
RISCO INDERTEMINADO	0
BAIXÍSSIMO RISCO	0100, 0200
BAIXO RISCO	0300
MÉDIO RISCO	0400, 0500, 0600
ALTO RISCO	0700, 0800
ALTÍSSIMO RISCO	0900, 1000

Response Consig Service

Quando o serviço CONSIG SERVICE (serviço consignado) é executado, os seguintes campos são retornados:

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do serviço
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Consig Service
createAt	string	Data e hora da execução do serviço
serproCode	string	Código da Serpro, conforme tabela
serproScore	string	Score de similaridade da face (de 0.00 à 1.0) do Serpro
score	string	Score Classe de Risco (0 a 1000), conforme tabela
risk	string	É o conceito referente ao score da Classe de Risco
image	string	URL/base64 utilizado na execução do serviço

Tabela do objeto "serproCode"

code	Descrição
200	Certificação Positiva
300	Certificação Negativa
SP1001	Menor de idade
SP1002	Face do CPF não cadastrada na Serpro
SP1003	Dados encontrados na base não atendem aos requisitos mínimos para validação
SP5001	Baixa qualidade na imagem enviada
SP5002	Erros de Integração

Response Doc Core

Response Typification

Quando o serviço TYPIFICATION é executado, os seguintes campos são retornados:

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Typification
createAt	string	Data e hora da execução do serviço;
faceA	string	Link de acesso à imagem da face A do documento do usuário;
faceB	string	Link de acesso à imagem da face B do documento do usuário;
documentType	string	Tipologia da documentação (RG, CNH, DNI ou CIN);

Response OCR

Quando o serviço OCR é executado, os seguintes campos são retornados:

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result).

Tabela do objeto "result" (array)

📘
Sobre os objetos retornados no OCR
O retorno deste serviço depende exclusivamente do tipo de documento que é enviado na jornada do usuário, dos tipos: CNH, DNI, CIN ou RG.

Objeto	Tipo	Descrição
serviceProtocol	string	Protocolo da execução do serviço Consig Service
createAt	string	Data e hora da execução do serviço;
protocol	string	Protocolo da Certiface API (interno);
status	string	Status da execução do serviço (OK, ERROR);
faceA	string	Link de acesso à imagem da face A do documento do usuário;
faceB	string	Link de acesso à imagem da face B do documento do usuário;
documentType	string	Tipologia da documentação (RG, CNH, DNI ou CIN);
state	string	Estado (UF) de emissão de documento;
document	string	Identificação do tipo de documento;
name	string	Nome do usuário;
originDoc	string	Dados do documento de origem: número de identificação e emissor de origem.
birthDate	string	Data de Nascimento (formato: dd/mm/yyyy);
formattedBirthDate	string	Data de Nascimento (formato: yyyy-mm-dd);
parentage	string	Nome do pai e nome da mãe do usuário;
registrationNumber	string	Número do registro do documento
expirationDate	string	Data de validade do documento (formato: "dd/mm/yyyy").
firstLicense	string	Data da primeira habilitação (formato: "dd/mm/yyyy").
location	string	Cidade e estado onde foi emitido o documento ("SÃO PAULO, SP").
issueDate	string	Data da expedição do documento (formato: "dd/mm/yyyy").
formattedIssueDate	string	Data da expedição do documento (formato: yyyy-mm-dd).
securityCode	string	Código de segurança.
mirror	string	Número de controle do documento (papel documento).
renach	string	Numeração do Renach.
creationDate	string	Data de criação do processo (formato: "yyyy-mm-dd hh:mm:ss").
fatherName	string	Nome do Pai.
motherName	string	Nome da Mãe.
cpf	string	Número do CPF (formato "999.999.999-99").
issuingBody	string	Nomenclatura dos documentos RG, DNI e CIN.
frontObservation	string	Observação
otherRG	string	Número de outro RG caso possua.
agency	string	Órgão Emissor.
factor	string	Tipo sanguíneo com fator Rh.
civilRegistration	string	Informação de origem do Registro civil.
driverLicense	string	Número do CNH.
nationalHealthCard	string	Cartão Nacional de Saúde.
workCard	string	Número da Carteira de Trabalho Previdência Social.
workCardSerial	string	Série da Carteira de Trabalho Previdência Social.
workCardState	string	UF de emissão da Carteira de Trabalho Previdência Social.
dni	string	Número do DNI.
voterID	string	Número do Título de Eleitor.
militaryCertificate	string	Número da Certidão Militar.
socialName	string	Nome Social.
pis	string	Número do PIS.
professional	string	Identidade Profissional ou CIP.
rg	string	Número do RG.
gender	string	Gênero do titular do documento.
nationality	string	Nacionalidade do titular do documento.
placeOfBirthday	string	Local de nascimento apresentado no documento.
isIlliterate	boolean	Identificação de assinatura do usuário no documento para leitura no OCR. Enviado de acordo com o tipo de documento (RG, CNH, DNI ou CIN). True = documento não assinado; False: documento assinado.

Response Documentoscopy

Quando o serviço DOCUMENTOSCOPY é executado, os seguintes campos são retornados:

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço Documentoscopy
createAt	string	Data e hora da execução do serviço;
faceA	string	Link de acesso à imagem da face A do documento do usuário;
faceB	string	Link de acesso à imagem da face B do documento do usuário;
score	integer (int32)	valor 0 à 100% da possibilidade do documento ser verdadeiro, onde 100% quer dizer que o documento passou com sucesso por todas as regras cadastradas no sistema e padrões do estado emissor.

Response FaceMatch

Quando o serviço FACEMATCH é executado, os seguintes campos são retornados:

Objeto	Tipo	Descrição
service	string	Serviço a qual determinado resultado pertence
state	string	Estado atual da execução do service
result	string	Array de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

Objeto	Tipo	Descrição
status	string	Status da execução do serviço (OK, ERROR)
protocol	string	Protocolo da Certiface API (interno)
serviceProtocol	string	Protocolo da execução do serviço FaceMatch
createAt	string	Data e hora da execução do serviço;
code	string	Código do Facematch na tabela abaixo: Código de Facematch;
cause	string	Mensagem referente ao código da resposta: Causa de Facematch.
score	string	Score de similaridade da face (selfie) e a foto do documento (valor de 0 a 1).
selfieImage	string	Imagem da biometria enviada pelo usuário.
documentImage	string	Imagem da face A do documento do usuário;

Tabela Código FaceMatch

Código	Causa	Descrição da causa Facematch
200	Validação positiva.	Biometria validada corretamente com o documento (faces similares).
300	Validação negativa.	Biometria não validada corretamente com o documento (similaridade baixa).
400	Face não encontrada no documento.	Face não encontrada no tratamento do documento.
401	Falha na validação documento-biometria.	Falha interna na validação do documento.
402	Documento ilegível.	Falta de legibilidade/qualidade da imagem. Recomenda-se nova captura de imagem.