> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/credit-services/credit-history.md). # Credit History Consulta el **historial crediticio** de una persona en los **burós de crédito de Nigeria** a partir de su BVN y retorna el perfil crediticio del titular, incluyendo el **resumen de préstamos** y su rendimiento. ### Endpoint ``` POST /kyc/nga/credit-history/{provider} ``` ### Autenticación | Tipo | Ubicación | Nombre | | ------- | --------- | ------------- | | API Key | Header | **x-api-key** | ### Parámetros de ruta | Parámetro | Tipo | Requerido | Descripción | | ---------- | ------ | --------- | ---------------------------------------------------------------------------------------------- | | `provider` | string | **Sí** | Buró de crédito a consultar. Valores posibles: `crc`, `xds`, `all` (consulta **ambos** burós). | ### 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** del titular. | #### Ejemplo de solicitud ``` POST /kyc/nga/credit-history/all ``` ```json { "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](#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 el perfil crediticio del titular. Ver tabla a continuación. | #### Parámetros de respuesta — `data` **Nota:** el objeto `data` se retorna **sin mapeo ni normalización de campos**. El perfil del titular y el historial crediticio son **únicos** (consolidados), no un bloque por buró. | Parámetro | Tipo | Descripción | | ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `providers` | array | Lista de **burós que retornaron información**, como array de strings. Valores posibles: `crc`, `xds`. Al consultar un único buró contiene solo ese valor. | | `profile` | object | **Perfil del titular** (único). Ver tabla a continuación. | | `credit_history` | array | **Historial crediticio** agrupado por institución financiera. Ver tabla a continuación. | #### Parámetros de respuesta — `profile` | Parámetro | Tipo | Descripción | | ----------------- | ------ | ---------------------------------------------------------------------------------------------------------- | | `full_name` | string | Nombre completo del titular. | | `date_of_birth` | string | Fecha de nacimiento. | | `gender` | string | Género, en minúsculas. Ej.: `male`, `female` | | `address_history` | array | Direcciones reportadas. Cada elemento contiene `address`, `type` y `date_reported`. | | `email_address` | array | Correos electrónicos registrados (array de strings). | | `phone_number` | array | Números de teléfono registrados (array de strings). | | `identifications` | array | Identificaciones del titular. Cada elemento contiene `no` (número) y `type` (ej.: `BVN`, `NIN`, `PENCOM`). | #### Parámetros de respuesta — `credit_history[]` | Parámetro | Tipo | Descripción | | ------------- | ------ | --------------------------------------------------------------------------- | | `institution` | string | Institución financiera que reportó los préstamos. | | `history` | array | Lista de préstamos reportados por la institución. Ver tabla a continuación. | #### Parámetros de respuesta — `history[]` | Parámetro | Tipo | Descripción | | --------------------- | ------ | -------------------------------------------------------------- | | `date_opened` | string | Fecha de apertura del préstamo. | | `closed_date` | string | Fecha de cierre del préstamo. | | `currency` | string | Moneda del préstamo. Ej.: `NGN` | | `institution` | string | Institución financiera (se repite dentro de cada préstamo). | | `loan_status` | string | Estado del préstamo. Ej.: `open`, `closed` | | `opening_balance` | number | Monto de apertura del préstamo. | | `performance_status` | string | Rendimiento del préstamo. Ej.: `performing` | | `repayment_amount` | number | Monto de la cuota de pago. | | `repayment_frequency` | string | Frecuencia de pago. Ej.: `monthly` | | `repayment_schedule` | array | Calendario de pagos. Cada elemento contiene `date` y `status`. | | `tenor` | number | Plazo del préstamo (en meses). | #### 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 ```json { "serviceResultCode": 200, "serviceTime": "2400", "serviceResultLog": "Success", "serviceTransactionId": "e41h235i-34i2-1h3l-h86h-2i681hj22jk", "data": { "credit_history": [ { "institution": "GUARANTY TRUST BANK PLC", "history": [ { "date_opened": "09-05-2019", "closed_date": "25-10-2020", "currency": "NGN", "institution": "GUARANTY TRUST BANK PLC", "loan_status": "closed", "opening_balance": 2009930, "performance_status": "performing", "repayment_amount": 0, "repayment_frequency": "monthly", "repayment_schedule": [ { "date": "01-06-2019", "status": "performing" } ], "tenor": 12 } ] } ], "profile": { "full_name": "JOHN PAUL DOE", "date_of_birth": "15-01-1990", "gender": "male", "address_history": [ { "address": "12 SAMPLE STREET, IKEJA, LAGOS", "type": "residential", "date_reported": "30-11-2021" } ], "email_address": [ "john.doe@example.com" ], "phone_number": [ "08012345678" ], "identifications": [ { "no": "12345678901", "type": "BVN" }, { "no": "09876543212", "type": "NIN" } ] }, "providers": ["crc", "xds"] } } ``` #### `400` Bad Request Se retorna cuando el `provider` indicado **no es válido**. En este caso la respuesta usa el formato `application/problem+json`, ya que la validación ocurre **antes** de procesar la consulta: ```json { "status": 400, "title": "Bad Request", "detail": "Invalid request.", "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400", "errors": [ "provider must be one of: crc, xds, all" ] } ``` Cuando la solicitud contiene datos incorrectos para la consulta, el error se retorna con el sobre del servicio (`serviceResultCode` refleja el código HTTP de la respuesta): ```json { "serviceResultCode": 400, "serviceResultLog": "Sorry, lookup failed. Please check the details and try again", "serviceTime": "151", "serviceTransactionId": "08ac9699-dc9e-4cdc-81d7-264f71838309" } ``` #### `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`: ```json { "serviceResultCode": 500, "serviceResultLog": "Service temporarily unavailable. Please try again later", "serviceTime": "3000", "serviceTransactionId": "38de2932-0f2h-7gff-14g0-597h04161632" } ``` #### `504` Gateway Timeout Error de **timeout**, retornado con el sobre del servicio: ```json { "serviceResultCode": 504, "serviceResultLog": "Request timeout. Please try again", "serviceTime": "30000", "serviceTransactionId": "48ef3043-1g3i-8hgg-25h1-608i15272743" } ``` {% hint style="info" %} 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](/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria.md#manejo-de-errores) para el detalle de las tres formas de respuesta. {% endhint %}