This page provides examples of the E_KYC_CHECK response for Singapore (sgp_gov_singpass).

GREEN

The following response examples represent successful checks.

{
  "checks": [
    {
      "answer": "GREEN",
      "checkType": "E_KYC_CHECK",
      "createdAt": "2025-11-06 13:29:49",
      "id": "9522d69a-1a6b-4aa9-b1d3-840ecac21a91",
      "inputDoc": {
        "idDocType": "OTHER",
        "country": "SGP"
      },
      "extractedDoc": {
        "country": "SGP",
        "idDocType": "ID_CARD",
        "number": "S7790690H",
        "firstName": "XIA YIN CHOW",
        "gender": "F",
        "phone": "+6599472910",
        "email": "[email protected]",
        "dob": "1996-01-03",
        "addresses": [
          {
            "flatNumber": "2-101",
            "street": "FIR AVENUE",
            "buildingNumber": "11",
            "town": "Singapore",
            "postCode": "670148",
            "country": "SGP",
            "formattedAddress": "FIR AVENUE, 11 2-101, Singapore, Singapore, 670148",
            "source": "externalDb"
          }
        ],
        "additionalFields": [
          {
            "name": "passportNumber",
            "value": "E93874729W"
          },
          {
            "name": "passportExpiryDate",
            "value": "2027-03-03"
          }
        ]
      },
      "ekycCheckInfo": {
        "confirmationId": "gDbo0UcV26LNA135y44AbxlL",
        "confirmationType": "options"
      }
    }
  ]
}

{
  "checks": [
    {
      "answer": "GREEN",
      "checkType": "E_KYC_CHECK",
      "createdAt": "2025-11-06 13:33:47",
      "id": "50894a7f-be8f-4d56-bcf7-ec391fa2fab7",
      "inputDoc": {
        "idDocType": "OTHER",
        "country": "SGP"
      },
      "extractedDoc": {
        "country": "SGP",
        "idDocType": "RESIDENCE_PERMIT",
        "number": "G4440430W",
        "firstName": "ALFRED CHONG BOON HAO",
        "gender": "M",
        "phone": "+6597399245",
        "email": "[email protected]",
        "dob": "1948-11-12",
        "addresses": [
          {
            "flatNumber": "2-123",
            "street": "HAVELOCK ROAD",
            "buildingNumber": "18",
            "town": "Singapore",
            "postCode": "597642",
            "country": "SGP",
            "formattedAddress": "HAVELOCK ROAD, 18 2-123, Singapore, Singapore, 597642",
            "source": "externalDb"
          }
        ],
        "additionalFields": [
          {
            "name": "passType",
            "value": "SPass"
          },
          {
            "name": "passStatus",
            "value": "Live"
          },
          {
            "name": "passExpiryDate",
            "value": "2030-12-31"
          }
        ]
      },
      "ekycCheckInfo": {
        "confirmationId": "dPvL5A2O2E8RnPWy3GdNKNPm",
        "confirmationType": "options"
      }
    }
  ]
}

YELLOW

The following example illustrates a case where the verification process is still in progress and the applicant has not yet completed all required steps.

{
  "checks": [
    {
      "answer": "YELLOW",
      "checkType": "E_KYC_CHECK",
      "createdAt": "2025-11-06 21:39:24",
      "id": "faf3469c-7320-4533-8d78-901072fb8f5b",
      "inputDoc": {
        "idDocType": "OTHER",
        "country": "SGP"
      },
      "ekycCheckInfo": {
        "confirmationId": "TX0zGu2IT6YQYkMcMXTYorh8",
        "confirmationType": "oAuth"
      }
    }
  ]
}

Response explained

The response represents a singleton list of checks.

Root variables

The root variables are the core Non-Doc check result data items. Some of them may include nested attributes and element fields.

Field	Type	Description
`id`	String	Unique identifier of the check.
`answer`	String	Check answer: `GREEN` — the check has passed successfully. Data found in the database. `YELLOW` — verification process is not yet complete. We await the applicant's completion of the required steps.
`inputDoc`	Object	Represents the data used for the database check.
`checkType`	String	Indicates that it is a `E_KYC_CHECK` check type.
`extractedDoc`	Object	External check source data. It may not be present if the data is not received.
`createdAt`	Date	Date and time (UTC) of the latest Non-Doc check result.

`inputDoc` attributes

The following table explains the inputDoc attributes representing the data taken from the provided document.

Field	Type	Description
`idDocType`	String	Type of the document provided for verification. For example, `TAX_PAYER_NUMBER_DOC`, `ID_CARD`, `PASSPORT`, `DRIVERS`.
`country`	String	Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on).

`extractedDoc` attributes

The extractedDoc object includes the data obtained from the external source during the E_KYC_CHECK check.

Field	Type	Description
`country`	String	Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on).
`idDocType`	String	Type of the identification number, extracted from Singpass: `ID_CARD` — National Registration Identity Card (NRIC) number, a unique identifier assigned to Singapore Citizens and Permanent Residents. `RESIDENCE_PERMIT` — Foreign Identification Number (FIN), a unique identifier assigned to foreigners.
`number`	String	NRIC number or FIN.
`firstName`	String	Applicant full name.
`dob`	Date	Applicant date of birth (format `YYYY-mm-dd`, for example, `2001-09-25`) as it is specified in the document.
`gender`	String	Gender of the applicant (`M`, `F`, or `X`).
`phone`	String	Applicant phone number.
`email`	String	Applicant email address.
`addresses`	Array of objects	The list of addresses extracted from the external check sources.
`additionalFields`	Array of objects	A collection of key-value pairs, representing additional information about the applicant.

`addresses` element fields

The following table explains the addresses element fields containing the applicant address details extracted from external sources.

Field	Type	Description
`street`	String	Street name.
`buildingNumber`	String	Block number.
`subStreet`	String	Building name.
`flatNumber`	String	Floor and unit number in the format: `{floor}-{unit}`.
`town`	String	City, town, or another settlement.
`state`	String	State, region, district, county, or another territorial entity inside a country.
`postCode`	String	Address postal code.
`country`	String	Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on).
`formattedAddress`	String	Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`.

`additionalFields` element fields

An array of key-value pairs providing non-standard additional information. The following table explains the possible keys.

Field	Type	Description
`passportNumber`	String	Passport number. Returned only for Singapore citizens.
`passportExpiryDate`	Date	Date when the passport validity expires. Returned only for Singapore citizens.
`passType`	String	Pass type of a Foreign Identification Number (FIN) holder, applicable only to foreigners with a valid pass. Possible values:: `RPass` — Work Permit. `SPass` — S Pass. `P1Pass` — Employment Pass. `P2Pass` — Employment Pass. `QPass` — Employment Pass. `PEP` — Personalised Employment Pass. `WHP` — Work Holiday Pass. `TEP` — Training Employment Pass. `Entre` — EntrePass. `OVE` — Overseas Networks & Expertise Pass. `DP` — Dependent Pass. `LTVP` — Long-Term Visit Pass. `LOC` — Letter of Consent. `MWP` — Miscellaneous Work Pass. `STP` — Student's Pass. `LTVP+` — Long-Term Visit Pass Plus. `IEO` — Immigration Exemption Order.
`passStatus`	String	Pass status of a Foreign Identification Number (FIN) holder, applicable only to foreigners with a valid pass. Possible values: `Live`. `Approved` — Interim status indicates that the FIN holder has not yet received the pass.
`passExpiryDate`	Date	Pass expiry date of a Foreign Identification Number (FIN) holder, applicable only to foreigners with a valid pass (format `YYYY-mm-dd`, for example, `2001-09-25`).

GREEN

YELLOW

Response explained

Root variables

inputDoc attributes

extractedDoc attributes

addresses element fields

additionalFields element fields

`inputDoc` attributes

`extractedDoc` attributes

`addresses` element fields

`additionalFields` element fields