Encontre as descrições dos objetos, códigos e score de risco

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:

ObjetoTipoDescrição
idstringIdentificador do resultado retornado
ticketstringTicket relacionado ao resultado
externalIdstringId passado pelo cliente na abertura do ticket
ticketStatusstringStatus do ticket (active, done, awaiting, inactive, error, retry)
reasonInvalidationstringMotivo da invalidação do ticket, caso tenha sido invalidado, segue abaixo tabela com detalhes (Tabela Reason Invalidation)
createAtstringData e hora da abertura do ticket
updateAtstringData e hora da ultima inserção no result

Tabela do objeto "Reason Invalidation" (array)

ObjetoTipoDescrição
typestringMotivo da invalidação (INVALID_WORKFLOW, BUSINESS_ROLES e outros)
descriptionstringDescriçã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)

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Prova de Vida
createAtstringData do processamento da Prova de Vida (Formato isoUtcDateTime: yyyy-mm-dd'T'HH:MM:ss:l'Z')
documentNumberstringNúmero do documento do cliente
namestringNome do cliente
birthstringData de nascimento do cliente
imagestringLink de acesso a imagem enviada
codeIdstringCódigo da Prova de Vida conforme Tabela abaixo
validstringResultado do teste de vivacidade

Tabela do objeto "codeId"

codeIdDescrição
1.0Prova de Vida Aprovada
300.1Prova de Vida Reprovada (face não identificada; necessário retentativa)
300.2Prova 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)

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Bureau
createAtstringData e hora da execução do serviço
imagestringURL/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)

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Bureau
createAtstringData e hora da execução do serviço
codestringcode da execução do serviço, segue abaixo tabela com detalhes (Tabela Code)
approvedstringTrue indica que a transação foi aprovada com baixa possibilidade de fraude; False indica alta possibilidade de fraude ou erro.
scorestringScore de biometria. Float de 0 a 1.
knownstringTrue indica que o usuário já possui cadastro sólido na base; False indica cadastro recente ou com baixa confiança.
firstCertificationstringIndica se trata-se da primeira certificação.
imagestringURL/base64 utilizado na execução do serviço

Tabela do objeto "code"

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

Response Serpro

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

services (array)

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Serpro
createAtstringData e hora da execução do serviço
imagestringURL/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:

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Risk Class
createAtstringData e hora da execução do serviço
riskstringÉ o conceito referente ao score da Classe de Risco (Tabela classe de risco)
scorestringRecomendaçã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 INDERTEMINADO0
BAIXÍSSIMO RISCO0100, 0200
BAIXO RISCO0300
MÉDIO RISCO0400, 0500, 0600
ALTO RISCO0700, 0800
ALTÍSSIMO RISCO0900, 1000

Response Consig Service

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

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do serviço
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Consig Service
createAtstringData e hora da execução do serviço
serproCodestringCódigo da Serpro, conforme tabela
serproScorestringScore de similaridade da face (de 0.00 à 1.0) do Serpro
scorestringScore Classe de Risco (0 a 1000), conforme tabela
riskstringÉ o conceito referente ao score da Classe de Risco
imagestringURL/base64 utilizado na execução do serviço

Tabela do objeto "serproCode"

codeDescrição
200Certificação Positiva
300Certificação Negativa
SP1001Menor de idade
SP1002Face do CPF não cadastrada na Serpro
SP1003Dados encontrados na base não atendem aos requisitos mínimos para validação
SP5001Baixa qualidade na imagem enviada
SP5002Erros de Integração

Response Doc Core

Response Typification

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

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Typification
createAtstringData e hora da execução do serviço;
faceAstringLink de acesso à imagem da face A do documento do usuário;
faceBstringLink de acesso à imagem da face B do documento do usuário;
documentTypestringTipologia da documentação (RG, CNH, DNI ou CIN);

Response OCR

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

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray 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.

ObjetoTipoDescrição
serviceProtocolstringProtocolo da execução do serviço Consig Service
createAtstringData e hora da execução do serviço;
protocolstringProtocolo da Certiface API (interno);
statusstringStatus da execução do serviço (OK, ERROR);
faceAstringLink de acesso à imagem da face A do documento do usuário;
faceBstringLink de acesso à imagem da face B do documento do usuário;
documentTypestringTipologia da documentação (RG, CNH, DNI ou CIN);
statestringEstado (UF) de emissão de documento;
documentstringIdentificação do tipo de documento;
namestringNome do usuário;
originDocstringDados do documento de origem: número de identificação e emissor de origem.
birthDatestringData de Nascimento (formato: dd/mm/yyyy);
formattedBirthDatestringData de Nascimento (formato: yyyy-mm-dd);
parentagestringNome do pai e nome da mãe do usuário;
registrationNumberstringNúmero do registro do documento
expirationDatestringData de validade do documento (formato: "dd/mm/yyyy").
firstLicensestringData da primeira habilitação (formato: "dd/mm/yyyy").
locationstringCidade e estado onde foi emitido o documento ("SÃO PAULO, SP").
issueDatestringData da expedição do documento (formato: "dd/mm/yyyy").
formattedIssueDatestringData da expedição do documento (formato: yyyy-mm-dd).
securityCodestringCódigo de segurança.
mirrorstringNúmero de controle do documento (papel documento).
renachstringNumeração do Renach.
creationDatestringData de criação do processo (formato: "yyyy-mm-dd hh:mm:ss").
fatherNamestringNome do Pai.
motherNamestringNome da Mãe.
cpfstringNúmero do CPF (formato "999.999.999-99").
issuingBodystringNomenclatura dos documentos RG, DNI e CIN.
frontObservationstringObservação
otherRGstringNúmero de outro RG caso possua.
agencystringÓrgão Emissor.
factorstringTipo sanguíneo com fator Rh.
civilRegistrationstringInformação de origem do Registro civil.
driverLicensestringNúmero do CNH.
nationalHealthCardstringCartão Nacional de Saúde.
workCardstringNúmero da Carteira de Trabalho Previdência Social.
workCardSerialstringSérie da Carteira de Trabalho Previdência Social.
workCardStatestringUF de emissão da Carteira de Trabalho Previdência Social.
dnistringNúmero do DNI.
voterIDstringNúmero do Título de Eleitor.
militaryCertificatestringNúmero da Certidão Militar.
socialNamestringNome Social.
pisstringNúmero do PIS.
professionalstringIdentidade Profissional ou CIP.
rgstringNúmero do RG.
genderstringGênero do titular do documento.
nationalitystringNacionalidade do titular do documento.
placeOfBirthdaystringLocal de nascimento apresentado no documento.
isIlliteratebooleanIdentificaçã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:

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço Documentoscopy
createAtstringData e hora da execução do serviço;
faceAstringLink de acesso à imagem da face A do documento do usuário;
faceBstringLink de acesso à imagem da face B do documento do usuário;
scoreinteger (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:

ObjetoTipoDescrição
servicestringServiço a qual determinado resultado pertence
statestringEstado atual da execução do service
resultstringArray de execuções do serviço, segue abaixo tabela com detalhes (Tabela Result)

Tabela do objeto "result" (array)

ObjetoTipoDescrição
statusstringStatus da execução do serviço (OK, ERROR)
protocolstringProtocolo da Certiface API (interno)
serviceProtocolstringProtocolo da execução do serviço FaceMatch
createAtstringData e hora da execução do serviço;
codestringCódigo do Facematch na tabela abaixo: Código de Facematch;
causestringMensagem referente ao código da resposta: Causa de Facematch.
scorestringScore de similaridade da face (selfie) e a foto do documento (valor de 0 a 1).
selfieImagestringImagem da biometria enviada pelo usuário.
documentImagestringImagem da face A do documento do usuário;

Tabela Código FaceMatch

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