## Available methods

| Method      | SDK ID      | Country                          |
|-------------|-------------|----------------------------------|
| Singpass    | `singpass`  | Singapore (SG)                  |
| DigiLocker  | `digilocker`| India (IN)                       |
| UAE Pass    | `uae_pass`  | United Arab Emirates (AE)       |

## Available attributes by method

All attributes are returned via `GET /omni/get/ocr-data/v2` under the `ocrData` object. Two fields identify the credential:

- `documentSubmissionMethod` — always `IMPORTED_CREDENTIAL` for digital ID sessions
- `credentialsProvider` — identifies the specific scheme (e.g. `uae_pass`)

### Singpass — Singapore

| Attribute                  | `ocrData` field                |
|----------------------------|--------------------------------|
| Family name                | `name.paternalLastName`       |
| Full name                  | `name.fullName`               |
| Date of birth              | `birthDate`                   |
| Nationality                | `nationality`                 |
| Gender                     | `gender`                       |
| Phone number               | `phone`                        |
| Street                     | `addressFields.street`        |
| Postal code                | `addressFields.postalCode`    |
| Country                    | `issuingCountry`              |
| Document type              | `typeOfId`                    |
| Document number            | `documentNumber`              |
| Expiry date                | `expireAt`                    |

### DigiLocker — India

| Attribute                  | `ocrData` field                |
|----------------------------|--------------------------------|
| Given name                 | `name.givenName`              |
| Family name                | `name.paternalLastName`       |
| Date of birth              | `birthDate`                   |
| Gender                     | `gender`                       |
| Full address               | `address`                      |
| Aadhaar number (masked)    | `documentNumber`              |
| Portrait photo             | via `/omni/get/images`        |

### UAE Pass — United Arab Emirates

| Attribute                  | `ocrData` field                |
|----------------------------|--------------------------------|
| Given name                 | `name.givenName`              |
| Family name                | `name.paternalLastName`       |
| Date of birth              | `birthDate`                   |
| Emirates ID number         | `documentNumber`              |
| Expiry date                | `expireAt`                    |
| Portrait photo             | via `/omni/get/images`        |

Updated 3 months ago