Verificar endereço

Verifica a direção de residência de uma pessoa na Nigéria a partir do número do medidor elétrico e a companhia de distribuição elétrica (DisCo) que atende o endereço.

Endpoint

POST /kyc/nga/address

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
meter_number	string	Sim	Número do medidor elétrico associado ao endereço.
address	string	Sim	Endereço a ser verificado.
disco_code	string	Sim	Código da companhia de distribuição elétrica (DisCo) que atende o endereço. Ex.: IKEJA. Veja a lista completa de valores abaixo.

Lista de códigos DisCo aceitos (49 valores):

Valores aceitos de disco_code

ABUJA, BENIN, EKO, IKEJA, IBADAN, ENUGU, PH, JOS, KADUNA, KANO, BH, PROTOGY, PHISBOND, ACCESSPOWER, YOLA, ABIA, ADAMAWA, AKWA IBOM, ANAMBRA, BAUCHI, BAYELSA, BENUE, BORNO, CROSS RIVER, DELTA, EBONYI, EDO, EKITI, GOMBE, IMO, JIGAWA, KATSINA, KEBBI, KOGI, KWARA, LAGOS, NASSARAWA, NIGER, OGUN, ONDO, OSUN, OYO, PLATEAU, RIVERS, SOKOTO, TARABA, YOBE, ZAMFARA, FCT

Exemplo de solicitação

{
  "meter_number": "04123456789",
  "address": "12 Sample St, Ikeja",
  "disco_code": "IKEJA"
}

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 o resultado da verificação do endereço. Veja a tabela abaixo.

Parâmetros de resposta — data

Nota: o objeto data é retornado sem mapeamento nem normalização de campos.

Parâmetro	Tipo	Descrição
verified	boolean	Indica se o endereço foi verificado contra os registros da companhia de distribuição elétrica.
confidence_level	number	Nível de confiança da correspondência, de 0 a 100.
disco_code	string	Código da companhia de distribuição elétrica consultada.
house_address	string	Endereço registrado junto à companhia de distribuição elétrica.
house_owner	string	Nome do titular registrado junto à companhia de distribuição elétrica.

Service Result Code

O serviceResultCode indica o resultado geral da execução do serviço e reflete o código de status HTTP da resposta:

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": {
    "verified": true,
    "confidence_level": 100,
    "disco_code": "IKEJA",
    "house_address": "12 Sample St, Ikeja, Lagos",
    "house_owner": "JOHN PAUL DOE"
  }
}

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.