---
title: Philippines Credit Bureau  Check
slug: us-apis/philippines-credit-bureau-check
createdAt: 2024-10-30T14:13:56.659Z
---

### Overview

The Philippines Credit Bureau Verification API enables real-time verification of personal and identity information against credit bureau data. This API assists financial institutions in ensuring the accuracy of customer data against official credit records in the Philippines, enhancing credit risk analysis and fraud prevention measures.

### Usecase

This API is essential for financial institutions, credit providers, and any entity involved in credit disbursement or financial assessments in the Philippines. It helps in:

- **Enhancing credit decision processes:** By verifying personal details against credit bureau records.
- **Minimizing fraud:** By ensuring the information provided by customers matches that held by the credit bureaus.
- **Compliance adherence:** Assisting in adherence to local financial regulations and anti-money laundering (AML) standards.

# API Details

## Request Body

:::CodeblockTabs
PreProduction

```json
curl --location 'https://api-preproduction.sig.app/api/v3/global-kyc/verify/ph/credit-bureau' \
--header 'Authorization: <----Auth Token---->' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Lanie",
    "lastName": "Avida",
    "middleName": "G",
    "dateOfBirth": "1960-09-25",
    "addressLine1": "Cebu Region 7",
    "addressLine2": "Tangil",
    "addressLine3": "Dumanjug",
    "addressLine4": "Cebu",
    "addressLine5": "6035",
    "identityInformation": {
        "nationalIdNumber": "1023456789",
        "nationalIdType": "SSS"
    },
    "consent": true
}'
```

Production

```json
curl --location 'https://api.signzy.app/api/v3/global-kyc/verify/ph/credit-bureau' \
--header 'Authorization: <----Auth Token---->' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Lanie",
    "lastName": "Avida",
    "middleName": "G",
    "dateOfBirth": "1960-09-25",
    "addressLine1": "Cebu Region 7",
    "addressLine2": "Tangil",
    "addressLine3": "Dumanjug",
    "addressLine4": "Cebu",
    "addressLine5": "6035",
    "identityInformation": {
        "nationalIdNumber": "1023456789",
        "nationalIdType": "SSS"
    },
    "consent": true
}'
```
:::

## Request Body Parameters

| Parameter           | Type    | Description                                         | Mandatory/Optional                       |
| ------------------- | ------- | --------------------------------------------------- | ---------------------------------------- |
| firstName           | String  | First name of the individual                        | Yes                                      |
| lastName            | String  | Last name of the individual                         | Yes                                      |
| middleName          | String  | Middle name of the individual                       | No                                       |
| dateOfBirth         | Date    | Date of birth (format: YYYY-MM-DD)                  | Yes                                      |
| addressLine1 to 5   | String  | Components of the residential address               | No                                       |
| identityInformation | Object  | Container for identity details                      | Yes                                      |
| nationalIdNumber    | String  | National identification number                      | Yes                                      |
| nationalIdType      | String  | Type of national ID (SSS, TIN, GSIS)                | Optional (Mandatory if NID is not blank) |
| consent             | Boolean | Consent from the individual to perform verification | Yes                                      |

```json
{
    "result": {
        "verificationResult": {
            "firstName": true,
            "middleName": true,
            "lastName": true,
            "dateOfBirth": true,
            "addressLine1": true,
            "addressLine2": true,
            "addressLine3": true,
            "addressLine4": true,
            "addressLine5": true,
            "nationalIdNumber": true,
            "nameMatchScore": "1.000",
            "addressMatchScore": "1.000"
        },
        "verificationStatus": "Verified",
        "reason": "All provided details match credit bureau records."
    }
}
```

### Response Body Parameters

| Parameter          | Type    | Description                                                                                                |
| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------- |
| verificationResult | Object  | Detailed results of the individual data fields verified against the credit bureau data.                    |
| firstName          | Boolean | Result of the first name verification; true if it matches the credit bureau records, false otherwise.      |
| middleName         | Boolean | Result of the middle name verification; true if it matches, false otherwise.                               |
| lastName           | Boolean | Result of the last name verification; true if it matches, false otherwise.                                 |
| dateOfBirth        | Boolean | Result of the date of birth verification; true if it matches, false otherwise.                             |
| addressLine1       | Boolean | Verification result for the first line of the address; true if it matches, false otherwise.                |
| addressLine2       | Boolean | Verification result for the second line of the address; true if it matches, false otherwise.               |
| addressLine3       | Boolean | Verification result for the third line of the address; true if it matches, false otherwise.                |
| addressLine4       | Boolean | Verification result for the fourth line of the address; true if it matches, false otherwise.               |
| addressLine5       | Boolean | Verification result for the fifth line of the address; true if it matches, false otherwise.                |
| nationalIdNumber   | Boolean | Result of the national ID number verification; true if it matches the credit bureau data, false otherwise. |
| nameMatchScore     | String  | Numerical score representing the match quality of the name with the credit bureau records.                 |
| addressMatchScore  | String  | Numerical score representing the match quality of the address with the credit bureau records.              |
| verificationStatus | String  | Overall status of the verification, typically "Verified" or "Not Verified".                                |
| reason             | String  | Description of why certain fields did not verify, listing all fields that were not verified.               |

## Error Code and Response Mapping

:::CodeblockTabs
400 (Bad Request)

```json
{
  "error": {
     "name": "error",
     "message": "Bad Input and description ",
     "status": 400,
     "reason": "VALIDATION_ERROR",
     "type": "Bad Request",
     "statusCode": 400
  }
}
```

401(Unauthorized)

```json
{
  "error": {
     "name": "error",
     "message": "Invalid authentication credentials",
     "status": 401,
     "reason": "AUTHENTICATION_ERROR",
     "type": "Bad Request",
     "statusCode": 401
  }
}
```

403 (Forbidden)

```json
{
  "error": {
     "name": "error",
     "message": "Forbidden",
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": "403"
  }
}
```

500 (Internal Server Error)

```json
{
  "error": {
     "name": "error",
     "message": "Internal server error",
     "status": 500,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 500
  }
}
```

409(Upstream Down

```json
{
  "error": {
     "name": "error",
     "message": "Upstream Down",
     "status": 409,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 409
  }
}
```
:::

| **Field**    | **Type** | **Description**                                     |
| ------------ | -------- | --------------------------------------------------- |
| `name`       | string   | Text displayed on the screen explaining error type. |
| `reason`     | string   | Reason for the error.                               |
| `status`     | number   | HTTP status code.                                   |
| `message`    | string   | Error message indicating an upstream error.         |
| `type`       | string   | Error type.                                         |
| `statusCode` | number   | Status code representing the error scenario.        |

:::hint{type="info"}
### Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [help@signzy.com](#). We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
:::



