For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Saltar al contenido

BVN Details

Consulta directamente los datos completos del BVN (Bank Verification Number) de Nigeria sin el flujo de consentimiento OTP. Es una alternativa al flujo de verificación BVN de 3 pasos (BVN Initiate, BVN Send OTP, BVN Verify OTP) cuando no se requiere la validación por OTP del titular.

Nota: cada solicitud se factura aunque la consulta falle. Se recomienda validar el formato del BVN (11 dígitos numéricos) en el lado del cliente antes de enviar la solicitud.

Endpoint

POST /kyc/nga/bvn/details

Autenticación

Tipo
Ubicación
Nombre

API Key

Header

x-api-key

Cuerpo de la solicitud

Content-Type: application/json

Parámetros

Parámetro
Tipo
Requerido
Descripción

bvn

string

Sí

Bank Verification Number de 11 dígitos.

Ejemplo de solicitud

{
  "bvn": "12345678901"
}

Respuestas

200 Éxito

Parámetros de respuesta

Parámetro
Tipo
Descripción

serviceResultCode

integer

Código que indica el resultado general de la ejecución del servicio. Ver Service Result Code

serviceTime

string

Tiempo de procesamiento (milisegundos).

serviceResultLog

string

Campo descriptivo del resultado de la ejecución del servicio. Incluye detalles cuando hay un error o excepción en el módulo.

serviceTransactionId

string

Identificador de transacción asociado a la solicitud procesada por la API.

data

object

Objeto con los datos completos del BVN. Ver tabla a continuación.

Parámetros de respuesta — data

Nota: el objeto data se retorna sin mapeo ni normalización de campos. Los nombres y la ortografía de los campos se conservan exactamente tal cual se reciben.

Parámetro
Tipo
Descripción

bvn

string

Bank Verification Number.

first_name

string

Nombre(s) del titular.

middle_name

string

Segundo nombre.

last_name

string

Apellido(s) del titular.

dob

string

Fecha de nacimiento.

gender

string

Género.

email

string

Dirección de correo electrónico registrada.

phone_number

string

Número de teléfono registrado.

phone_number_2

string

Número de teléfono alternativo registrado.

address

string

Dirección de residencia.

state_of_origin

string

Estado de origen.

lga_of_origin

string

Área de Gobierno Local (LGA) de origen.

lga_of_Residence

string

Área de Gobierno Local (LGA) de residencia. El campo se llama literalmente lga_of_Residence (sic): la ortografía se conserva tal cual se recibe.

marital_status

string

Estado civil.

nin

string

National Identification Number asociado al BVN.

nationality

string

Nacionalidad.

registration_date

string

Fecha de registro del BVN.

watch_listed

boolean

Indica si el titular figura en lista de vigilancia.

photoId

string

Foto del titular en formato Base64.

Service Result Code

El serviceResultCode indica el resultado general de la ejecución del servicio y refleja el código de estado HTTP de la respuesta:

serviceResultCode
Descripción
Código HTTP

200

La ejecución del servicio fue exitosa, el módulo procesó la solicitud correctamente.

200

Ejemplo de respuesta

400 Bad Request

Error retornado con el sobre del servicio (serviceResultCode refleja el código HTTP de la respuesta):

502 Bad Gateway

Se retorna cuando el servicio no está disponible temporalmente o su respuesta no pudo interpretarse. El cuerpo usa el sobre del servicio con serviceResultCode: 500:

504 Gateway Timeout

Error de timeout, retornado con el sobre del servicio:

Los errores de autenticación (401/403) son rechazados por el gateway antes de llegar al servicio y no usan el sobre serviceResultCode. Los errores de validación de la plataforma usan el formato application/problem+json. Consulta Manejo de errores para el detalle de las tres formas de respuesta.

Última actualización