Singpass Developer Docs
Verify API (legacy)
Verify API (legacy)
  • Introduction
    • Overview
  • Key Principles
  • Verify API Data Catalog
  • Brand Guidelines and Resources
  • FAQ
  • Technical Specifications
    • Verify API
    • Technical Requirements
  • Testing with Test Personas
  • Error Code
Powered by GitBook
On this page
  • Data Available
  • Basic Identity Data
  • Additional Data
  • Data Catalog

Was this helpful?

Verify API Data Catalog

Data Available

Verify leverages Myinfo profile, and provides the following data:

Basic Identity Data

  • This refers to data reflected in identification documents such as NRIC, Work Pass (EP, PEP, EntrePass, S-Pass), Dependent Pass, Visit Pass (LTVP, LTVP+), selected Work Permit, Driver’s Licence, and Passport.

Additional Data

  • This additional data provides businesses with alternative identifiers such as partial NRIC/FIN or UUID and contact details such as mobile number and email address.

Data Catalog

id
name
description
Data Available
Source

uinfin

NRIC/FIN

NRIC number or FIN of user. NRIC number is the unique identifier given to every Singapore Citizens (SC) and Permanent Residents (PR), while FIN is the unique identifier for Foreigners.

SC,PR,FIN

ICA/MOM

partialuinfin

Partial NRIC/FIN

Last 3 numerical digits and checksum of the NRIC/FIN number, prefixed with '*****' (e.g. "*****567A" from the full NRIC number of "S1234567A").

SC,PR,FIN

-

name

Principal Name

Full name of user printed on NRIC or FIN card. Includes Surname if any.

SC,PR,FIN

ICA/MOM

aliasname

Alias Name

Refers to an alternate/additional name of the user that is legally recognised.

SC,PR

ICA

hanyupinyinname

Hanyu Pinyin Name

Refers to the officially romanised Chinese name of the user.

SC,PR

ICA

hanyupinyinaliasname

Hanyu Pinyin Alias Name

Refers to the legally-recognised alternate officially romanised Chinese name of the user.

SC,PR

ICA

marriedname

Married Name

Refers to the family name or surname adopted by the user upon marriage.

SC,PR

ICA

sex

Sex

SC,PR,FIN

ICA/MOM

race

Race

SC,PR,FIN

ICA/MOM

secondaryrace

Secondary Race

Refers to secondary racial category of the Person, if any.

SC,PR

ICA

dialect

Dialect

SC,PR

ICA

dob

Date of Birth

SC,PR,FIN

ICA/MOM

residentialstatus

Residential Status

SC,PR

ICA

nationality

Nationality/Citizenship

SC,PR,FIN

ICA/MOM

birthcountry

Country/Place of Birth

SC,PR,FIN

ICA/MOM

passportnumber

Passport Number

SC

ICA

passportexpirydate

Passport Expiry Date

SC

ICA

passtype

Pass Type

This refers to the pass type of a FIN holder.

Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM.

FIN

ICA/MOM

passstatus

Pass Status

This refers to the pass status of a FIN holder.

Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM.

FIN

ICA/MOM

passexpirydate

Pass Expiry Date

This refers to the pass expiry date of a FIN holder.

Note that this only applies to a FIN holder with a valid pass issued by ICA/MOM.

FIN

ICA/MOM

employmentsector

Employment Sector

This refers to the employment sector of a FIN holder.

Note that this only applies to a FIN holder with a valid pass issued by MOM.

FIN

MOM

mobileno

Mobile Number

Mobile number must be made editable at digital services even though data source is Singpass.

SC,PR,FIN

Singpass

email

Email Address

Email address must be made editable at digital services even though data source is Singpass.

SC,PR,FIN

Singpass

regadd

Registered Address

For SC/PR - Registered address is the address that is printed on the NRIC card.

For FIN - Registered address is applicable for foreigners under the following Pass Types: ICA-issued Passes - Long Term Visit Pass / Long Term Visit Pass + - Student Pass - Immigration Exemption Order MOM-issued Passes - S Pass - Employment Pass - Personalised Employment Pass - EntrePass - Dependent Pass

SC,PR,FIN

ICA/MOM

PreviousKey PrinciplesNextBrand Guidelines and Resources

Last updated 1 month ago

Was this helpful?

Gender of the user. Refer to (SexCode) for list of possible values.

Refer to (RaceCode) for list of possible values

Refer to (RaceCode) for list of possible values

Refer to (DialectCode) for list of possible values

Indicate if the user is a Citizen, PR or others. Blank value will be returned for FIN holder. Refer to (ResidentialCode) for list of possible values

Refer to (NationalityCitizenshipCode) for list of possible values

Refer to (CountryPlaceCode) for list of possible values

Refer to (PassTypeCode) for list of possible values.

Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing
Code Listing