Panamá
Serviço de validação civil para o Panamá. Realiza a Verificação de Identidade contra os dados do Registro Civil do Panamá.
Endpoint
POST /services/civilValidationCabeçalhos
x-api-key
string
Sim
API Key de autorização de acesso.
family
string
Não
Valor: Onboarding. Obrigatório com o serviço de Tracking.
Todas as chamadas aos Endpoints para Tracking com Identity Platform devem conter o header family.
Validação Completa Mobile
Realiza a validação de dados e a correspondência facial contra o Registro Civil do Panamá utilizando a plataforma móvel.
Corpo da solicitação
Content-Type: application/json
Parâmetros
operation
string
Sim
Operação de validação a ser realizada. Valor: "FULL".
platform
string
Sim
Plataforma a partir da qual a solicitação é realizada. Valor: "MOBILE".
tokenOcr
string
Sim
Token gerado pelo Widget SelphID nativo ou híbrido, criptografado em AES256 e Tokenizado, enviado em formato Base64. Contém o resultado OCR do Documento de identidade capturado.
bestImage
string
Sim
Imagem em aberto do rosto do usuário. Necessária para operações FACIAL ou FULL.
countryCode
string
Sim
Código do país no formato ISO 3166-1 alfa-3. Valor: "PAN".
returnPII
boolean
Não
Indica se deseja receber os dados pessoais gerados pelo serviço OCR e a resposta do Registro Civil.
documentValidation
boolean
Não
Indica se deseja iniciar a validação do documento, retornando scanReference e type.
rastreamento
object
Não
Objeto que representa as informações de Tracking necessárias.
tracking.extraData
string
Não
Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas com a Plataforma.
tracking.operationId
string
Não
Identificador de operação gerado pelo SDK Mobile/Web.
Exemplo de solicitação
Respostas
200 Sucesso
Parâmetros de resposta
serviceResultCode
integer
Código que indica o resultado geral da execução do serviço. Ver Código de Resultado do Serviço.
serviceTime
string
Tempo total de processamento (milissegundos).
serviceResultLog
string
Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção.
serviceTransactionId
string
Identificador da transação associado à solicitação processada pela API.
civilDataValidation
array
Array que representa as validações OCR contra os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.
civilDataValidation[].field
string
Nome do campo validado (ex. firstName, lastName, dateOfBirth).
civilDataValidation[].code
string
Código do resultado da validação. "0": Validado corretamente. "-99": Possivelmente adulterado.
civilDataValidation[].message
string
Mensagem descritiva do resultado da validação.
serviceFacialAuthenticationResult
integer
Código que indica o resultado da coincidência facial. Ver Resultado da Autenticação Facial do Serviço.
serviceFacialSimilarityResult
number
Valor que indica a semelhança facial entre o rosto na foto do documento e a selfie do usuário. 1.0 = 100%.
serviceFacialAuthenticationHash
string
Hash de integridade do Template Biométrico utilizado em uma autenticação facial positiva ou incerta.
serviceDocument
string
String JSON que representa o documento capturado. Suas propriedades são todos os campos extraídos pelo processo OCR.
civilServiceData
string
String JSON com os dados pessoais obtidos do Registro Civil (só é retornado se returnPII foi enviado como true na solicitação).
Exemplo de resposta
Validação Completa Web
Realiza a validação de dados e a correspondência facial contra o Registro Civil do Panamá utilizando a plataforma web.
Corpo da solicitação
Content-Type: application/json
Parâmetros
operation
string
Sim
Operação de validação a ser realizada. Valor: "FULL".
platform
string
Sim
Plataforma a partir da qual a solicitação é realizada. Valor: "WEB".
imageFrontDocument
string
Sim
Captura frontal do documento, imagem em Base64 sem o cabeçalho de tipo MIME. Requerido para a plataforma WEB.
imageBackDocument
string
Sim
Captura traseira do documento, imagem em Base64 sem o cabeçalho de tipo MIME. Requerido para a plataforma WEB.
bestImage
string
Sim
Imagem em aberto do rosto do usuário. Necessária para operações FACIAL ou FULL.
countryCode
string
Sim
Código do país no formato ISO 3166-1 alfa-3. Valor: "PAN".
returnPII
boolean
Não
Indica se deseja receber os dados pessoais gerados pelo serviço OCR e a resposta do Registro Civil.
documentValidation
boolean
Não
Indica se deseja iniciar a validação do documento, retornando scanReference e type.
rastreamento
object
Não
Objeto que representa as informações de Tracking necessárias.
tracking.extraData
string
Não
Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas com a Plataforma.
tracking.operationId
string
Não
Identificador de operação gerado pelo SDK Mobile/Web.
Exemplo de solicitação
Respostas
200 Sucesso
Parâmetros de resposta
serviceResultCode
integer
Código que indica o resultado geral da execução do serviço. Ver Código de Resultado do Serviço.
serviceTime
string
Tempo total de processamento (milissegundos).
serviceResultLog
string
Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção.
serviceTransactionId
string
Identificador da transação associado à solicitação processada pela API.
civilDataValidation
array
Array que representa as validações OCR contra os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.
civilDataValidation[].field
string
Nome do campo validado (ex. firstName, lastName, dateOfBirth).
civilDataValidation[].code
string
Código do resultado da validação. "0": Validado corretamente. "-99": Possivelmente adulterado.
civilDataValidation[].message
string
Mensagem descritiva do resultado da validação.
serviceFacialAuthenticationResult
integer
Código que indica o resultado da coincidência facial. Ver Resultado da Autenticação Facial do Serviço.
serviceFacialSimilarityResult
number
Valor que indica a semelhança facial entre o rosto na foto do documento e a selfie do usuário. 1.0 = 100%.
serviceFacialAuthenticationHash
string
Hash de integridade do Template Biométrico utilizado em uma autenticação facial positiva ou incerta.
serviceDocument
string
String JSON que representa o documento capturado. Suas propriedades são todos os campos extraídos pelo processo OCR.
civilServiceData
string
String JSON com os dados pessoais obtidos do Registro Civil (só é retornado se returnPII foi enviado como true na solicitação).
Exemplo de resposta
Validação Facial Mobile
Realiza a correspondência facial contra as imagens oficiais do Registro Civil do Panamá utilizando a plataforma móvel. Não inclui validação de dados.
Corpo da solicitação
Content-Type: application/json
Parâmetros
operation
string
Sim
Operação de validação a ser realizada. Valor: "FACIAL".
platform
string
Sim
Plataforma a partir da qual a solicitação é realizada. Valor: "MOBILE".
bestImage
string
Sim
Imagem em aberto do rosto do usuário. Necessária para operações FACIAL ou FULL.
documentNumber
string
Não
Número do documento do usuário.
countryCode
string
Sim
Código do país no formato ISO 3166-1 alfa-3. Valor: "PAN".
rastreamento
object
Não
Objeto que representa as informações de Tracking necessárias.
tracking.extraData
string
Não
Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas com a Plataforma.
tracking.operationId
string
Não
Identificador de operação gerado pelo SDK Mobile/Web.
Exemplo de solicitação
Respostas
200 Sucesso
Parâmetros de resposta
serviceResultCode
integer
Código que indica o resultado geral da execução do serviço. Ver Código de Resultado do Serviço.
serviceTime
string
Tempo total de processamento (milissegundos).
serviceResultLog
string
Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção.
serviceTransactionId
string
Identificador da transação associado à solicitação processada pela API.
civilDataValidation
array
Array que representa as validações OCR contra os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.
civilDataValidation[].field
string
Nome do campo validado (ex. firstName, lastName, dateOfBirth).
civilDataValidation[].code
string
Código do resultado da validação. "0": Validado corretamente. "-99": Possivelmente adulterado.
civilDataValidation[].message
string
Mensagem descritiva do resultado da validação.
serviceFacialAuthenticationResult
integer
Código que indica o resultado da coincidência facial. Ver Resultado da Autenticação Facial do Serviço.
serviceFacialSimilarityResult
number
Valor que indica a semelhança facial entre o rosto na foto do documento e a selfie do usuário. 1.0 = 100%.
serviceFacialAuthenticationHash
string
Hash de integridade do Template Biométrico utilizado em uma autenticação facial positiva ou incerta.
Exemplo de resposta
Validação Facial Web
Realiza a correspondência facial contra as imagens oficiais do Registro Civil do Panamá utilizando a plataforma web. Não inclui validação de dados.
Corpo da solicitação
Content-Type: application/json
Parâmetros
operation
string
Sim
Operação de validação a ser realizada. Valor: "FACIAL".
platform
string
Sim
Plataforma a partir da qual a solicitação é realizada. Valor: "WEB".
bestImage
string
Sim
Imagem em aberto do rosto do usuário. Necessária para operações FACIAL ou FULL.
documentNumber
string
Não
Número do documento do usuário.
countryCode
string
Sim
Código do país no formato ISO 3166-1 alfa-3. Valor: "PAN".
rastreamento
object
Não
Objeto que representa as informações de Tracking necessárias.
tracking.extraData
string
Não
Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas com a Plataforma.
tracking.operationId
string
Não
Identificador de operação gerado pelo SDK Mobile/Web.
Exemplo de solicitação
Respostas
200 Sucesso
Parâmetros de resposta
serviceResultCode
integer
Código que indica o resultado geral da execução do serviço. Ver Código de Resultado do Serviço.
serviceTime
string
Tempo total de processamento (milissegundos).
serviceResultLog
string
Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção.
serviceTransactionId
string
Identificador da transação associado à solicitação processada pela API.
civilDataValidation
array
Array que representa as validações OCR contra os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.
civilDataValidation[].field
string
Nome do campo validado (ex. firstName, lastName, dateOfBirth).
civilDataValidation[].code
string
Código do resultado da validação. "0": Validado corretamente. "-99": Possivelmente adulterado.
civilDataValidation[].message
string
Mensagem descritiva do resultado da validação.
serviceFacialAuthenticationResult
integer
Código que indica o resultado da coincidência facial. Ver Resultado da Autenticação Facial do Serviço.
serviceFacialSimilarityResult
number
Valor que indica a semelhança facial entre o rosto na foto do documento e a selfie do usuário. 1.0 = 100%.
serviceFacialAuthenticationHash
string
Hash de integridade do Template Biométrico utilizado em uma autenticação facial positiva ou incerta.
Exemplo de resposta
Tabelas de referência
Código de Resultado do Serviço
O serviceResultCode indica o resultado geral da execução do serviço:
0
A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente.
200
Resultado da Autenticação Facial do Serviço
O serviceFacialAuthenticationResult indica o resultado das operações de coincidência facial (somente para operações FULL e FACIAL):
0
NONE
Não foi possível realizar a verificação facial.
1
NEGATIVE
O processo foi executado corretamente. A comparação do padrão facial dos rostos não corresponde.
3
POSITIVE
O processo foi executado corretamente. A comparação do padrão facial dos rostos é positiva. O valor de serviceFacialSimilarityResult indica a % de semelhança entre as imagens comparadas.
4
NENHUM DEVIDO A EXCESSO DE POSE
Não foi possível realizar a verificação facial devido à posição do rosto.
5
NENHUM DEVIDO A EXTRAÇÕES INVÁLIDAS
Não foi possível realizar a verificação facial devido a problemas na extração do padrão facial.
Erros comuns
400 Requisição inválida
401 Não autorizado
403 Acesso negado
502 Gateway inválido
504 Tempo limite do gateway
Atualizado