Verificar conta

Verifica um número de conta bancária na Nigéria e retorna o nome do titular da conta.

Endpoint

POST /kyc/nga/account-number

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
account_number	string	Sim	Número de conta bancária a verificar, formato NUBAN de 10 dígitos.
nip_code	string	Sim	Código NIP do banco. Veja o Endpoint /kyc/nga/banks para a lista de códigos.

Exemplo de solicitação

{
  "nip_code": "000015",
  "account_number": "0123456789"
}

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 Service Result Code
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 conta verificada. Veja a tabela a seguir.

Parâmetros de resposta — data

Parâmetro	Tipo	Descrição
name	string	Nome do titular da conta.
account_number	string	Número da conta verificado.
bvn	string | null	BVN associado à conta (null se não estiver disponível).
bank	object	Objeto com os dados do banco. Veja a tabela a seguir.

Parâmetros de resposta — data.bank

Parâmetro	Tipo	Descrição
name	string	Nome do banco.
code	string	Código NIP do banco.

Service Result Code

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": "1100",
  "serviceResultLog": "Success",
  "serviceTransactionId": "d30g124h-23h1-0g2k-g75g-1h570gi11ij",
  "data": {
    "name": "JOHN PAUL DOE",
    "account_number": "0123456789",
    "bvn": "12345678901",
    "bank": {
      "name": "Zenith Bank",
      "code": "000015"
    }
  }
}

400 Bad Request

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

{
  "serviceResultCode": 400,
  "serviceResultLog": "Sorry, lookup failed. Please check the details and try again",
  "serviceTime": "151",
  "serviceTransactionId": "08ac9699-dc9e-4cdc-81d7-264f71838309"
}

502 Bad Gateway

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

{
  "serviceResultCode": 500,
  "serviceResultLog": "Service temporarily unavailable. Please try again later",
  "serviceTime": "3000",
  "serviceTransactionId": "38de2932-0f2h-7gff-14g0-597h04161632"
}

504 Gateway Timeout

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

{
  "serviceResultCode": 504,
  "serviceResultLog": "Request timeout. Please try again",
  "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 obter detalhes das três formas de resposta.