Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Honduras

Serviço de validação civil para Honduras. Realiza a verificação de identidade com os dados do Registro Civil de Honduras.

Endpoint

POST /services/civilValidation

Cabeçalhos

Nome
Tipo
Obrigatório
Descrição

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 de tracking com Identity Platform devem conter o cabeçalho family.

Full Validation Mobile

Realiza a validação de dados e a correspondência facial com o Registro Civil de Honduras usando a plataforma móvel.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

operation

string

Sim

Operação de validação a ser realizada. Valor: "FULL".

platform

string

Sim

Plataforma de onde a solicitação é feita. Valor: "MOBILE".

tokenOcr

string

Sim

Token gerado pelo Widget SelphID nativo ou híbrido, criptografado com AES256 e tokenizado, enviado em formato Base64. Contém o resultado do OCR do Documento de identidade capturado.

templateRaw

string

Sim

Template Biométrico gerado pelo Widget Selphi. Obrigatório para operações FACIAL ou FULL.

countryCode

string

Sim

Código do país no formato ISO 3166-1 alfa-3. Valor: "HND".

returnPII

boolean

Não

Indica se deseja receber os dados pessoais gerados pelo serviço de OCR e a resposta do Registro Civil.

documentValidation

boolean

Não

Indica se deseja iniciar a validação do documento, retornando scanReference e type.

tracking

object

Não

Objeto que representa as informações de rastreamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte 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 uma exceção.

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

civilDataValidation

array

Array que representa as validações de OCR em comparação com os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.

civilDataValidation[].field

string

Nome do campo validado (por exemplo, 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 correspondência facial. Consulte Resultado da autenticação facial do serviço.

serviceFacialSimilarityResult

number

Valor que indica a similaridade 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 usado 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 de OCR.

civilServiceData

string

String JSON com os dados pessoais obtidos do Registro Civil (retornado somente se returnPII foi enviado como true na solicitação).

Exemplo de resposta

Validação completa pela Web

Realiza a validação de dados e a correspondência facial com o Registro Civil de Honduras usando uma plataforma web.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

operation

string

Sim

Operação de validação a ser realizada. Valor: "FULL".

platform

string

Sim

Plataforma pela qual a solicitação é realizada. Valor: "WEB".

imageFrontDocument

string

Sim

Captura da frente do documento, imagem em Base64 sem o cabeçalho do tipo MIME. Obrigatório para a plataforma WEB.

imageBackDocument

string

Sim

Captura do verso do documento, imagem em Base64 sem o cabeçalho do tipo MIME. Obrigatório para a plataforma WEB.

templateRaw

string

Sim

Template Biométrico gerado pelo Widget Selphi. Obrigatório para operações FACIAL ou FULL.

countryCode

string

Sim

Código do país no formato ISO 3166-1 alfa-3. Valor: "HND".

returnPII

boolean

Não

Indica se deseja receber os dados pessoais gerados pelo serviço de OCR e a resposta do Registro Civil.

documentValidation

boolean

Não

Indica se deseja iniciar a validação do documento, retornando scanReference e type.

tracking

object

Não

Objeto que representa as informações de rastreamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte 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 uma exceção.

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

civilDataValidation

array

Array que representa as validações de OCR em comparação com os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.

civilDataValidation[].field

string

Nome do campo validado (por exemplo, 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 correspondência facial. Consulte Resultado da autenticação facial do serviço.

serviceFacialSimilarityResult

number

Valor que indica a similaridade 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 usado 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 de OCR.

civilServiceData

string

String JSON com os dados pessoais obtidos do Registro Civil (retornado somente se returnPII foi enviado como true na solicitação).

Exemplo de resposta

Validação de dados móvel

Realiza a validação de dados junto ao Registro Civil de Honduras por meio de uma plataforma móvel. Não inclui correspondência facial.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

operation

string

Sim

Operação de validação a ser realizada. Valor: "DATA".

platform

string

Sim

Plataforma de onde a solicitação é feita. Valor: "MOBILE".

tokenOcr

string

Sim

Token gerado pelo Widget SelphID nativo ou híbrido, criptografado com AES256 e tokenizado, enviado em formato Base64. Contém o resultado do OCR do Documento de identidade capturado.

countryCode

string

Sim

Código do país no formato ISO 3166-1 alfa-3. Valor: "HND".

returnPII

boolean

Não

Indica se deseja receber os dados pessoais gerados pelo serviço de OCR e a resposta do Registro Civil.

documentValidation

boolean

Não

Indica se deseja iniciar a validação do documento, retornando scanReference e type.

tracking

object

Não

Objeto que representa as informações de rastreamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte 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 uma exceção.

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

civilDataValidation

array

Array que representa as validações de OCR em comparação com os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.

civilDataValidation[].field

string

Nome do campo validado (por exemplo, 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.

serviceDocument

string

String JSON que representa o documento capturado. Suas propriedades são todos os campos extraídos pelo processo de OCR.

civilServiceData

string

String JSON com os dados pessoais obtidos do Registro Civil (retornado somente se returnPII foi enviado como true na solicitação).

Exemplo de resposta

Validação de dados web

Realiza a validação de dados junto ao Registro Civil de Honduras por meio de uma plataforma web. Não inclui correspondência facial.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

operation

string

Sim

Operação de validação a ser realizada. Valor: "DATA".

platform

string

Sim

Plataforma pela qual a solicitação é realizada. Valor: "WEB".

imageFrontDocument

string

Sim

Captura da frente do documento, imagem em Base64 sem o cabeçalho do tipo MIME. Obrigatório para a plataforma WEB.

imageBackDocument

string

Sim

Captura do verso do documento, imagem em Base64 sem o cabeçalho do tipo MIME. Obrigatório para a plataforma WEB.

countryCode

string

Sim

Código do país no formato ISO 3166-1 alfa-3. Valor: "HND".

returnPII

boolean

Não

Indica se deseja receber os dados pessoais gerados pelo serviço de OCR e a resposta do Registro Civil.

documentValidation

boolean

Não

Indica se deseja iniciar a validação do documento, retornando scanReference e type.

tracking

object

Não

Objeto que representa as informações de rastreamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte 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 uma exceção.

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

civilDataValidation

array

Array que representa as validações de OCR em comparação com os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.

civilDataValidation[].field

string

Nome do campo validado (por exemplo, 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.

serviceDocument

string

String JSON que representa o documento capturado. Suas propriedades são todos os campos extraídos pelo processo de OCR.

civilServiceData

string

String JSON com os dados pessoais obtidos do Registro Civil (retornado somente se returnPII foi enviado como true na solicitação).

Exemplo de resposta

Validação facial móvel

Realiza a correspondência facial com as imagens oficiais do Registro Civil de Honduras por meio de uma plataforma móvel. Não inclui validação de dados.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

operation

string

Sim

Operação de validação a ser realizada. Valor: "FACIAL".

platform

string

Sim

Plataforma de onde a solicitação é feita. Valor: "MOBILE".

templateRaw

string

Sim

Template Biométrico gerado pelo Widget Selphi. Obrigatório para operações FACIAL ou FULL.

documentNumber

string

Não

Número do documento do usuário. Obrigatório para operações FACIAL em Honduras.

countryCode

string

Sim

Código do país no formato ISO 3166-1 alfa-3. Valor: "HND".

tracking

object

Não

Objeto que representa as informações de rastreamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte 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 uma exceção.

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

civilDataValidation

array

Array que representa as validações de OCR em comparação com os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.

civilDataValidation[].field

string

Nome do campo validado (por exemplo, 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 correspondência facial. Consulte Resultado da autenticação facial do serviço.

serviceFacialSimilarityResult

number

Valor que indica a similaridade 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 usado em uma autenticação facial positiva ou incerta.

Exemplo de resposta

Validação facial web

Realiza a correspondência facial com as imagens oficiais do Registro Civil de Honduras por meio de uma plataforma web. Não inclui validação de dados.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

operation

string

Sim

Operação de validação a ser realizada. Valor: "FACIAL".

platform

string

Sim

Plataforma pela qual a solicitação é realizada. Valor: "WEB".

templateRaw

string

Sim

Template Biométrico gerado pelo Widget Selphi. Obrigatório para operações FACIAL ou FULL.

documentNumber

string

Não

Número do documento do usuário. Obrigatório para operações FACIAL em Honduras.

countryCode

string

Sim

Código do país no formato ISO 3166-1 alfa-3. Valor: "HND".

tracking

object

Não

Objeto que representa as informações de rastreamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de rastreamento 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

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte 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 uma exceção.

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

civilDataValidation

array

Array que representa as validações de OCR em comparação com os dados obtidos do Registro Civil. Sua presença depende do Registro Civil consultado.

civilDataValidation[].field

string

Nome do campo validado (por exemplo, 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 correspondência facial. Consulte Resultado da autenticação facial do serviço.

serviceFacialSimilarityResult

number

Valor que indica a similaridade 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 usado em uma autenticação facial positiva ou incerta.

Exemplo de resposta

Tabelas de referência

Código do resultado do serviço

O serviceResultCode indica o resultado geral da execução do serviço:

serviceResultCode
Descrição
Código HTTP

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 correspondência facial (somente para operações FULL e FACIAL):

Código
Resultado
Descrição

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 foi positiva. O valor de serviceFacialSimilarityResult indica a porcentagem de similaridade entre as imagens comparadas.

4

NONE BECAUSE POSE EXCEED

Não foi possível realizar a verificação facial devido à posição do rosto.

5

NONE BECAUSE INVALID EXTRACTIONS

Não foi possível realizar a verificação facial devido a problemas na extração do padrão facial.

Erros comuns

400 Solicitação inválida

401 Não autorizado

403 Proibido

413 Payload Too Large

A solicitação excede o tamanho máximo permitido. O gateway a rejeita sem processá-la: a resposta não inclui serviceResultCode nem serviceTransactionId. Consulte Limite de tamanho da solicitação.

Solicitação com mais de 6 MB e até 10 MB (Content-Type: application/json):

Solicitação com mais de 10 MB (10.485.760 bytes) (Content-Type: text; charset=utf-8, texto simples, não JSON):

502 Gateway inválido

504 Tempo limite do gateway

Atualizado