Verificar carteira de motorista

Verifica um número de Licença de motorista na Nigéria e retorna as informações do titular incluindo foto e dados da Licença.

Endpoint

POST /kyc/nga/driver-license

Autenticação

Tipo	Localização	Nome
API Key	Cabeçalho	x-api-key

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
license_number	string	Sim	Número de Licença de motorista.
date_of_birth	string	Sim	Data de nascimento do titular no formato YYYY-MM-DD.
first_name	string	Sim	Nome do titular.
last_name	string	Sim	Sobrenome do titular.

Exemplo de solicitação

{
  "license_number": "AAD23208212298",
  "date_of_birth": "1996-05-06",
  "first_name": "Samuel",
  "last_name": "Olamide"
}

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. Ver Código de Resultado do Serviço
serviceTime	string	Tempo de processamento (milissegundos).
serviceResultLog	string	Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção no módulo.
serviceTransactionId	string	Identificador de transação associado à solicitação processada pela API.
data	object	Objeto com os dados da Licença verificada. Veja a tabela abaixo.

Parâmetros de resposta — data

Parâmetro	Tipo	Descrição
license_no	string	Número da Licença verificado.
first_name	string	Nome(s) do titular.
middle_name	string	Nome do meio.
last_name	string	Sobrenome(s) do titular.
birth_date	string	Data de nascimento.
gender	string	Gênero. Valores possíveis: Male, Female
state_of_issue	string	Estado que emitiu a Licença.
issued_date	string	Data de emissão.
expiry_date	string	Data de expiração.
photo	string | null	Foto do titular em formato Base64 (pode ser null).

Código de Resultado do Serviço

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

serviceResultCode	Descrição	Código HTTP
200	A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente.	200

Exemplo de resposta

{
  "serviceResultCode": 200,
  "serviceTime": "1800",
  "serviceResultLog": "Success",
  "serviceTransactionId": "f52i346j-45j3-2i4m-i97i-3j792ik33kl",
  "data": {
    "gender": "Male",
    "photo": null,
    "license_no": "AAD23208212298",
    "first_name": "Samuel",
    "last_name": "Olamide",
    "middle_name": "Nomo",
    "issued_date": "2021-10-07",
    "expiry_date": "2026-06-04",
    "state_of_issue": "OYO",
    "birth_date": "1996-05-06"
  }
}

400 Requisição inválida

Erro retornado com o envelope do serviço (serviceResultCode reflete o código HTTP da resposta):

{
  "serviceResultCode": 400,
  "serviceResultLog": "Desculpe, a consulta falhou. Verifique os dados e tente novamente",
  "serviceTime": "151",
  "serviceTransactionId": "08ac9699-dc9e-4cdc-81d7-264f71838309"
}

502 Gateway inválido

É retornado quando o serviço está temporariamente indisponível ou sua resposta não pôde ser interpretada. O corpo usa o envelope do serviço com serviceResultCode: 500:

{
  "serviceResultCode": 500,
  "serviceResultLog": "Serviço temporariamente indisponível. Tente novamente mais tarde",
  "serviceTime": "3000",
  "serviceTransactionId": "38de2932-0f2h-7gff-14g0-597h04161632"
}

504 Tempo esgotado no gateway

Erro de Timeout, retornado com o envelope do serviço:

{
  "serviceResultCode": 504,
  "serviceResultLog": "Timeout da solicitação. Tente novamente",
  "serviceTime": "30000",
  "serviceTransactionId": "48ef3043-1g3i-8hgg-25h1-608i15272743"
}

Os erros de autenticação (401/403) são rejeitados pelo gateway antes de chegar ao serviço e não usam o envelope serviceResultCode. Os erros de validação da plataforma usam o formato application/problem+json. Consulte Tratamento de erros para ver os detalhes das três formas de resposta.