NAV undefined
undefined
bash

Introduction

Welcome! Here at Iluma, our mission is to provide digital infrastructure that helps you succeed. We help with data products to support your Know-Your-Customer (KYC) processes, and reduce risk for both money in (accepting payments) and money out (disbursing payments). Use cases range from platform business to fintech lending and eCommerce, and everything else in between.

The Iluma API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features and HTTP verbs, which are understood by off-the-shelf HTTP clients. JSON is returned by all API responses, including errors. These APIs are versioned by route and the latest version(s) will always be available here.

Learn our APIs with Postman

To make it easier to get familiar with our APIs, we've published a Postman collection so that you can see examples of the latest version of Iluma APIs in one place. In order to use these you will need to:

Authentication

To successfully authenticate with Iluma's API, you must use Basic Authentication with your API key as a username and no password. If you manually construct the request header to add the Authorization parameter, you must append a colon and Base 64 encode your API keys. For example if your API key is

iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

First, add a colon at the end

iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Finally, Base64 encode the colon appended key to get

aWx1bWFfZGV2ZWxvcG1lbnRfRlg0ZjBNNXN4RGdrNXFGeVpuazYwWmVuZ0FmQTlvMzF4M2VjZDI5dmloamM0Vmh5SjhGY2xaaEhqanc6

Iluma API is organized around REST to make it cleaner and easier to understand. All our API responses return JSON. To explore our APIs, you will need to obtain and authenticate API keys for both the development and live environments. All requests made in the development environment will hit dummy data and will not cost you anything.

Before using the API, make sure that you have registered and get your account authenticated as API requests without authentication will fail. Contact us to get started. Our sales team will process your application and send you the details you need to retrieve your API keys from the Get API Key endpoint. Then you can authenticate subsequent requests by including your secret API key in the request header. Your development and live keys determine your environment. Your Oauth Token and API keys should be kept private so do not share these.

All the API requests should be made over HTTPS instead of HTTP (all calls made over plain HTTP will fail). We’re developing libraries and plugins in the near future and if you write your own library, we would love to hear about it. Make sure you’ve completed the authentication before using our API.

Get API Key

Endpoint: Get API Key

GET https://api.iluma.ai/businesses/:business_id/api_keys?token=:token

Example Get API Key Request

curl https://api.iluma.ai/businesses/5abc/api_keys?token=123 \
    -X GET

In order to retrieve your Iluma API key, you will authenticate yourself by making a GET request to this endpoint using the Iluma business ID and Iluma OAuth token. You can get both business ID and OAuth token from our sales team after your account registration is successful.

Note that the token is single use only so you MUST save the API keys provided in the response payload when you make this request

Callback

A number of our services implement a callback flow in order to maintain an acceptable http request performance and user experience. These include Bank Name Validator, NPWP Validator eWallet Validator and ID Card OCR. Callbacks will contain the completed API response (i.e., a final success or failure status once we have processed your request through all available data sources). Refer to each product documentation for further information about their respective callback response.

The various methods described in this section allow you to set, retrieve and update your callback urls. The API responses are specific to the environment you are in, so use your development API key to set callbacks for the development environment, and the live API key to set callbacks for the live environment.

All callbacks will be sent by the following IP addresses: Live environment:

Development environment:

Callback Response Schema

Unless otherwise specified, all endpoints in this section will return according to the following schema

Parameter Description
status string (required)
The status you have set for this url
url string (required)
The url that we will send callbacks to
type string (required)
The endpoint for which the callback url is configured
created string (required)
ISO 8601 Timestamp showing when this callback url was initially set
updated string (required)
ISO 8601 Timestamp showing when this callback url was last updated
id string (required)
Our unique reference ID for this callback url setting

Callback Authentication Token

Endpoint: Callback Authentication Token

GET https://api.iluma.ai/v1/callback/authentication_tokens

Example Callback Authentication Token Request

curl https://api.iluma.ai/v1/callback/authentication_tokens \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Make a GET request to this endpoint to return your Callback Authentication Token. This token is included in the X-CALLBACK-TOKEN header of all responses we send to the callback urls you set using the other endpoints in this section. The token allows you to verify that any callbacks you receive are coming from us. Treat the token as a secret. If you need to change the token for whatever reason, Contact us.

Example Callback Authentication Token Response

{
    "token": "47a843dfd72a9f564b6fb2e4092294d939884d62602a1a7f3679820f7ce0d0f2",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Callback Authentication Token Response Schema

Parameter Description
token string (required)
The token. Treat it like a password
created string (required)
The created date of the token
updated string (required)
The last updated timestamp of the token
id string (required)
Unique callback authentication token ID

Create Callback Url

Endpoint: Create Callback Url

POST https://api.iluma.ai/v1/callback/urls

Example Create Callback Url Request

curl https://api.iluma.ai/v1/callback/urls \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "type": "EWALLET_ACCOUNT_VALIDATION",
        "url": "https://acme.client.com/webhook/ewallet"
    }'

Make a POST request to this endpoint to create a new callback url for the endpoint you want to set.

A test payload will be sent to your URL with the following content:

{
  "test": true
}

You need to make sure that your backend responds with HTTP status code 200 to this payload otherwise your callback URL will not be saved.

Create Callback Url Request

Parameter Description
type string (required)
The endpoint for which you want to configure a callback url. Permitted values are:
NPWP_DATA_REQUEST, NAME_VALIDATOR_REQUEST, EWALLET_ACCOUNT_VALIDATION, ID_IMAGE_OCR_REQUEST, BUNDLED_CREDIT_ENRICHMENT, BUSINESS_DOCUMENT_OCR_REQUEST, BANK_STATEMENT_OCR_REQUEST, DOCUMENT_OCR_CAPTURE_REQUEST
url string (required)
The url that you want us to send callbacks to

Example Create Callback Url Response

{
    "status": "ACTIVE",
    "url": "https://acme.client.com/webhook/ewallet",
    "type": "EWALLET_ACCOUNT_VALIDATION",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Create Callback Url Errors

Error Code Description
DUPLICATE_CALLBACK_URL_ERROR
400
A callback url for this type of callback is already set. Use the PATCH method instead to update
NON_2XX_RESPONSE_ERROR
400
Your url did not return a response in the 2XX http response code range.
REQUEST_FAILURE_ERROR
500
We failed in making a request to your url. Check that your URL is correct

List Callback Urls

Endpoint: List Callback Url

GET https://api.iluma.ai/v1/callback/urls

Example List Callback Url Request

curl https://api.iluma.ai/v1/callback/urls \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Make a GET request to this endpoint to retrieve a list of all callback urls you have set for the environment. If you have not yet set any callback urls we will return an error response.

Example List Callback Url Response

[
    {
        "status": "ACTIVE",
        "url": "https://acme.client.com/webhook/ewallet",
        "type": "EWALLET_ACCOUNT_VALIDATION",
        "created": "2019-01-08T08:08:08.888Z",
        "updated": "2019-01-08T08:08:08.888Z",
        "id": "59e608887eb26d005d44aeb8"
    },
    {
        "status": "INACTIVE",
        "url": "https://acme.client.com/webhook/name_validator",
        "type": "NAME_VALIDATOR_REQUEST",
        "created": "2019-01-08T08:08:08.888Z",
        "updated": "2019-01-08T08:08:08.888Z",
        "id": "59e608887eb26d005d44aeb8"
    }
]

List Callback Url Errors

Error Code Description
CALLBACK_URL_NOT_FOUND_ERROR
404
You have not set any callback url for that specific type yet.

Retreive Callback Url By Type

Endpoint: Retreive Callback Url By Type

GET https://api.iluma.ai/v1/callback/urls/:type

Example Retreive Callback Url By Type Request

curl https://api.iluma.ai/v1/callback/urls/NAME_VALIDATOR_REQUEST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Make a GET request to this endpoint to to retrieve a specific callback url which you have previously set. Supply the type as a parameter in the url

Example Retreive Callback Url By Type Response

{
    "status": "ACTIVE",
    "url": "https://acme.client.com/webhook/name_validator",
    "type": "NAME_VALIDATOR_REQUEST",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Retreive Callback Url By Type Errors

Error Code Description
CALLBACK_URL_NOT_FOUND_ERROR
404
You have not set any callback url for that specific type yet.

Update Callback Url By Type

Endpoint: Update Callback Url By Type

PATCH https://api.iluma.ai/v1/callback/urls/:type

Example Update Callback Url By Type Request: Change Url

curl https://api.iluma.ai/v1/callback/urls/NAME_VALIDATOR_REQUEST \
    -X PATCH \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -d url="https://acme.client.com/webhook/name_validator"

Example Update Callback Url Status By Type Request: Change status

curl https://api.iluma.ai/v1/callback/urls/NAME_VALIDATOR_REQUEST \
    -X PATCH \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -d status="INACTIVE"

Make a PATCH request to update either the callback url or status of your set url. Only one of either url or status should be updated at a time. Updating the status to INACTIVE allows you to temporarily stop receiving callback for a particular service. This is useful if you're under maintenance and do not want us to keep sending out request to your url.

Example Update Callback Url By Type Response

{
    "status": "ACTIVE",
    "url": "https://acme.client.com/webhook/name_validator",
    "type": "NAME_VALIDATOR_REQUEST",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Update Callback Url By Type Request

Parameter Description
status string (optional)
Status of the set callback url ACTIVE or INACTIVE
url string (optional)
The url that you want us to send callbacks to.

Update Callback Url By Type Errors

Error Code Description
CALLBACK_URL_NOT_FOUND_ERROR
404
You have not set any callback url for that specific type yet.
NON_2XX_RESPONSE_ERROR
400
Your url did not return a response in the 2XX http response code range.
REQUEST_FAILURE_ERROR
500
We failed in making a request to your url.

Identity

Iluma's suite of identity products helps you to streamline your user onboarding flows with automated extraction of information from user ID documents, check whether detatils users submit to you are internally consistent and match with official Government records, and that specific identifiers are actually owned by them.

Get Available Bank Codes

Endpoint: Get available bank codes

GET https://api.iluma.ai/bank/available_bank_codes

Example Get available bank codes

curl https://api.iluma.ai/bank/available_bank_codes \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Find the list of bank codes below for the banks we support. We support queries of accounts at 140+ banks in Indonesia, including some BPDs and BPRs. If you would like us to support a specific bank, please contact us

Bank Codes

Parameter Description
name string (required)
Bank name
code string (required)
Bank code
swift_code string (required)
Bank SWIFT code
remark string (optional)
Remarks for the bank code.

Example Get Available Bank Codes Response

[
    {
        "name": "Bank ANZ Indonesia",
        "code": "ANZ",
        "swift_code": "ANZBIDJX"
    },
    {
        "name": "Bank Artha Graha International",
        "code": "ARTHA",
        "swift_code": "ARTGIDJA"
    },
    {
        "name": "Bank Artos Indonesia",
        "code": "ARTOS",
        "swift_code": "ATOSIDJ1",
        "remark": "Deprecating in Jan 2023. Please use `JAGO` going forward"
    }
]

Bank Name Validator

Endpoint: Validate name on bank account and match with provided name

POST https://api.iluma.ai/v2.1/identity/bank_account_data_requests

Example Bank Name Validator Request

curl https://api.iluma.ai/v2.1/identity/bank_account_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "given_name": "FIRA DIYANKA",
    "surname": "FEBRIYANTI",
    "reference_id": "foo123"
    }' \

The Bank Name Validator can be used to look up the name attached to bank accounts in Indonesia and run a configurable name similarity algorithm betweeen the result and the provided name. It also provides an indication whether the account is a virtual bank account or not (e.g a Normal Account), allowing you to confirm that the account is truly owned by the individual and minimising your exposure to fraud.

Bank Name Validator Request

Parameter Description
bank_account_number string (required)
The bank account number

Note Bank accounts will be inquired strictly as entered. If the account number requires leading 0s, you should ensure these are retained
bank_code string (required)
The bank code. See Bank Codes
given_name string (required)
The given name that will be used for name matching purposes. Please do not include honorifics.
surname string (optional)
The surname that will be used for name matching purposes
reference_id string (optional)
Your identifier for this request. Providing this may help you to reconcile requests you make to our systems
upper_threshold number (optional)
(Default: 80)Integer, Minimum is 0, Maximum is 100. Indicate upper degree of matching tolerance
lower_threshold number (optional)
(Default: 40)Integer, Minimum is 0, Maximum is 100. Indicate lower degree of matching tolerance

Bank Name Validator Response

Example Bank Name Validator Response (Pending bank response)

{
    "status": "PENDING",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_59e608887eb26d005d44aeb8",
    "reference_id": "foo123"
}

Example Bank Name Validator Response (Account found, holder name matches)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false
    },
}

Example Bank Name Validator Response (Account found, holder name doesn't match)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "NOT_MATCH",
        "is_virtual_account": false
    },
}

Example Bank Name Validator Response (Account found, holder name match is not conclusive)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "UNCLEAR",
        "is_virtual_account": false
    },
}

Example Bank Name Validator Response (Account found, dengan attribut "need_review")

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false,
        "need_review": true
    },
}

Example Bank Name Validator Response (Account not found)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": false
    },
}

Example Bank Name Validator Response (Temporary network error on Iluma side, user won't be charged)

{
  "status": "FAILED",
  "bank_account_number": "1234567890",
  "bank_code": "BCA",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id": "bknv_5c6ba591cf3c3867d75053d7",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "reference_id": "foo123"
}

Our name similarity algorithm will find the degree of similarity between the found name and provided name. You will see three possible categories in the response, MATCH, UNCLEAR, or NOT_MATCH.

Note, if you set upper and lower threshold to the same number, then you will only get either MATCH or NOT_MATCH category.

Because it may take a few seconds to validate the bank account name with our sources, all results are returned to you in a callback. Be sure to have a callback URL configured for bank account data in your account (Set it with type: NAME_VALIDATOR_REQUEST). Please refer to Callback section for further details.

If the account number has not recently been queried, the synchronous HTTP response will have "status": "PENDING". For cases where we have recently queried the account, the synchronous HTTP response will contain the same response data as the callback.

Bank Name Validator Schema

Parameter Description
bank_code string (required)
The bank code. See Bank Codes
bank_account_number string (required)
The bank account number
status string (required)
PENDING The name validation request is still being processed
COMPLETED The name validation request has been processed successfully
FAILED The name validation request has failed to be processed
updated string (required)
The last updated date of the name validation request
id string (required)
Unique name validator request ID
reference_id string (optional)
Your identifier for this request. Will be present only if submitted in the request payload
result object (optional)
Only exist if status is COMPLETED

Result Object Schema

Parameter Description
is_found boolean (required)
Found the account or not
name_matching_result string (optional)
Only exist if status is COMPLETED
MATCH The name given is >above upper_threshold
NOT_MATCH The similarity between the name given and the account holder name is less than the lower_threshold
UNCLEAR The similarity between the name given and the account holder name is between lower_threshold and upper_threshold
is_virtual_account string (optional)
Only exist if status is COMPLETED with is_found is true
true indicates a virtual account (default), false indicates normal account.
This checks accounts at most major banks that issue virtual accounts: BNI, BCA, MANDIRI, BRI, CIMB, PERMATA, Maybank, NOBU Bank, Sinarmas, BTPN, BTN, Danamon, BJB, Bank Artha Graha, HSBC Indonesia. Other banks will return false by default
need_review string (optional)
Only exist if status is COMPLETED with is_found is true
true indicates account is found on some form of blacklists or reported fraudulent behaviour. please treat this as a warning sign and perform additional due diligence where appropriate.This feature is in beta stage and can be enabled by making a request through your account manager, our Customer Success team or writing to us at help@iluma.ai

Bank Name Validator Errors

Error Code Description
UNSUPPORTED_BANK_CODE_ERROR
400
Destination bank is not supported, request is using the wrong bank code.

Bank Name Validator: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v2.1/identity/bank_account_data_requests/:id

Example Bank Name Validator: Get by id Request

curl https://api.iluma.ai/v2.1/identity/bank_account_data_requests/qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can inquire on the status of an existing request by making a GET request to the resource using the id that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Bank Name Validator: Get by id Request

Parameter Description
id string (required)
The id of the request to retrieve. This id must match the unique bank account data request id provided in our response at the time of resource creation

Example Bank Name Validator: Get by id Response (Pending bank response)

{
    "status": "PENDING",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_59e608887eb26d005d44aeb8",
    "reference_id": "foo123"
}

Example Bank Name Validator Response (Account found, holder name matches)


{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false
    },
}

Example Bank Name Validator Response (Account found, dengan attribut "need_review")

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false,
        "need_review": true
    },
}

Example Bank Name Validator Response (Account not found)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": false
    },
}

Example Bank Name Validator Response (Temporary network error on Iluma side, user won't be charged)

{
  "status": "FAILED",
  "bank_account_number": "1234567890",
  "bank_code": "BCA",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id": "bknv_5c6ba591cf3c3867d75053d7",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "reference_id": "foo123"
}

Bank Name Validator Schema

Please refer to this section.

Ewallet Validator

Endpoint: Validate details of an ewallet account

POST https://api.iluma.ai/v0/identity/ewallet_account_data_requests

Example Ewallet Account Validator Request

curl https://api.iluma.ai/v0/identity/ewallet_account_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "ewallet_account_number": "08120000123",
        "ewallet_type": "GOPAY"
    }'

The Ewallet Account Validator can be used to validate the details of an account holder for major ewallets in Indonesia. We currently support GoPay, OVO, LinkAja, DANA and ShopeePay. We will be adding other sources as we gain access. Validating an ewallet account can help you to confirm destination of funds before you make a transfer into the wallet, and in some cases may assist to verify an applicant's identity.

Ewallet Account Validator Request

Parameter Description
ewallet_account_number string (required)
The ewallet account number. For ewallets which use mobile phone numbers, we support +62xxx, 08xxx with "-" or " " dividers
ewallet_type string (required)
The name of the ewallet you want to check. We currently support one of DANA, GOPAY, LINKAJA, OVO, or SHOPEEPAY

Ewallet Account Validator Response

Example Ewallet Account Validator Response (Pending eWallet response)

{
    "id": "9a48e1b2-da78-4561-8b02-f20fd89542d0",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08111",
    "result": {},
    "status": "PENDING",
    "is_found": null,
    "updated": "2017-07-03T10:51:44.484Z"
}
{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08222",
    "result": {
        "account_status": "ACTIVE",
        "ewallet_account_name": "FIRA DIYANKA"
    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Example Ewallet Account Validator Response (LINKAJA and GOPAY. Account found and verified - Account holder has done KYC verification)

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08223",
    "result": {
        "kyc_status": "VERIFIED",
        "account_status": "ACTIVE",
        "ewallet_account_name": "FIRA DIYANKA"

    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Example Ewallet Account Validator Response (LINKAJA and GOPAY. Account found and unverified. Account holder has not done KYC verification. Ewallet account name will be empty string.)

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08224",
    "result": {
        "kyc_status": "UNVERIFIED",
        "account_status": "ACTIVE",
        "ewallet_account_name": ""
    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Example Ewallet Account Validator Response (Account not found)

{
    "id": "cf366af5-9ea6-4d56-9f5a-8d7a9691ddf8",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08333",
    "result": {
        "account_status": null,
        "ewallet_account_name": null
    },
    "status": "COMPLETED",
    "is_found": false,
    "updated": "2020-01-03 08:23:16.521060+00:00"
}

Because it may take a few seconds to validate the ewallet name with our sources, all results are returned to you in a callback. The callback structure will be the same as the response schema below. Be sure to have a callback URL configured for ewallet account data in your account (Set it with type: EWALLET_ACCOUNT_VALIDATION). Please refer to Callback section for further details.

If the account number has not recently been queried, the synchronous HTTP response will have "status": "PENDING". For cases where we have recently queried the account, the synchronous HTTP response will contain the same response data as the callback.

Ewallet Account Validator Schema

Parameter Description
id string (required)
Unique ewallet account validator request ID
ewallet_type string (required)
The ewallet type. One of DANA, GOPAY, LINKAJA, OVO, or SHOPEEPAY
ewallet_account_number string (required)
The ewallet account number
result object (required)
JSON object containing all the information we can find about this account. This object will contain different content depending on the wallet type:
account_status
ACTIVE The account is active
INACTIVE The account has been closed
null The account is not found
ewallet_account_name The name associated with the eWallet account. May be a blank string if no name is available
kyc_status The verification status with the wallet provider (LINKAJA and GOPAY).
VERIFIED The account holder has done KYC verification
UNVERIFIED The account holder has not done KYC verification
status string (required)
PENDING The request is still being processed
WAITING_ON_SOURCE Your request is a duplicate and a previous request for this account is still PENDING
COMPLETED The ewallet validation request has been completed
is_found string (required)
Whether the ewallet account is found
updated string (required)
The last updated date of the ewallet account validation request in UTC ISO date format

Ewallet Account Validator Errors

Error Code Description
UNSUPPORTED_EWALLET_TYPE_ERROR
400
This ewallet type is not currently supported. Permitted ewallet accounts are shown in the request schema above
INVALID_ACCOUNT_NUMBER_FORMAT
400
This ewallet account number has invalid format.

Ewallet Validator: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v0/identity/ewallet_account_data_requests/:id

Example Ewallet Validator: Get by id request

curl https://api.iluma.ai/v0/identity/ewallet_account_data_requests/
qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can inquire on the status of an existing request by making a GET request to the resource using the id that is returned to you when creating the request resource. You will recieve a response of the same format as shown in the response schemas above.

Ewallet Validator: Get by id Request

Parameter Description
id string (required)
The id of the request to retrieve. This id must match the unique eWallet data request id provided in our response at the time of resource creation

Example Ewallet Validator: Get by id Response

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08222",
    "result": {
        "account_status": "ACTIVE",
        "ewallet_account_name": "FIRA DIYANKA"
    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

NPWP Validator

Endpoint: Validate NPWP

POST https://api.iluma.ai/v1/identity/npwp_data_requests

Example NPWP Validator Request

curl https://api.iluma.ai/v1/identity/npwp_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{ "account_number": "123456789012345" }'

NPWP Validator can be used to look up the account holder name of a tax identification number (NPWP) in Indonesia. We cover both businesses and individuals.

NPWP Validator Request

Parameter Description
account_number string (required)
15 digits NPWP number. Can be 15 digits or in a 12.345.678.9-012.345 format

NPWP Validator Response

If the account number has not recently been queried, the response will have "status": "PENDING", and you will be a sent a callback when the request completes. Be sure to have a callback URL configured for NPWP data in your account (Set it with type: NPWP_DATA_REQUEST). Please refer to Callback section for further details.

Example NPWP Validator Response (Pending)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "000000000000000",
  "status": "PENDING"
}

Example NPWP Validator Response (Account found)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "999999999999999",
  "status": "COMPLETED",
  "is_found": true,
  "result":{
    "account_name": "FIRA DIYANKA"
  }
}

Example NPWP Validator Response (Account not found)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "111111111111111",
  "status": "COMPLETED",
  "is_found": false,
  "result":{}
}

Example NPWP Validator Response (Failed)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "444444444444444",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "is_found": false,
  "result":{}
}

NPWP Validator Schema

Parameter Description
id string (required)
Unique NPWP request ID
created string (required)
The created date of the NPWP request
updated string (required)
The last updated date of the NPWP request
account_number string (required)
The NPWP account number you supplied
status string (required)
PENDING The NPWP request is still being processed
WAITING_ON_SOURCE The NPWP request is still being processed by our source
COMPLETED The NPWP request has completed processing
FAILED The NPWP request has failed processing due to one or more reasons. Please refer to failure_reason for more information.
failure_reason string (optional)
See NPWP Validator Failure Reasons
is_found boolean (required)
true The NPWP account number is valid and has been found.
false This NPWP account number is invalid or is not found.
result object (required)
JSON object containing all the information we can find about this account:
account_name
NPWP account holder name. May be null or blank

NPWP Validator Failure Reasons

Failure Reason Description
TEMPORARY_NETWORK_ERROR An upstream source returned a temporary error. You may retry this request.

NPWP Validator: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/npwp_data_requests/:id

Example NPWP Validator: Get by id request

curl https://api.iluma.ai/v1/identity/npwp_data_requests/
qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can inquire on the status of an existing request by making a GET request to the resource using the id that is returned to you when creating the request resource. You will recieve a response of the same format as shown in the response schemas above.

NPWP Validator: Get by id Request

Parameter Description
id string (required)
The id of the request to retrieve. This id must match the unique NPWP data request id provided in our response at the time of resource creation

Example NPWP Validator: Get by id Response

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "999999999999999",
  "status": "COMPLETED",
  "is_found": true,
  "result":{
    "account_name": "FIRA DIYANKA"
  }
}

KTP biometrics verification

Endpoint: id card verifications

POST https://api.iluma.ai/v0/identity/id_card_verifications

Example Id card verifications Request

curl https://api.iluma.ai/v0/identity/id_card_verifications \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -F 'name="penito kristian"' \
    -F 'id_card_number="3275031210930027"' \
    -F 'birthdate="12-10-1991"' \
    -F 'birthplace="Ketapang"' \
    -F 'address="Alinda kencana blok E"' \
    -F 'selfie=@"/path/to/file.png"''

The KTP verification endpoint exists to help you check if a given KTP or NIK number exists in the official records of the Indonesian government and checks if the selfie matches. In addition, if you submit non-essential card data, we can verify that it matches the official records.

Id card verifications Request

Parameter Description
name string (required)
Name of the individual as per the KTP card
Min - 2 characters, Max - 100 characters
id_card_number string (required)
The national identity card number as per the KTP card
birthdate string (optional)
Date of birth as shown on the KTP card
Format DD-MM-YYYY string
birthplace string (optional)
End-user's birth place as shown on the KTP card
address string (optional)
End-user’s address as shown on the KTP card
selfie file (required)
Selfie image of the individual to check against the image that Dukcapil holds for the supplied NIK
Supported mime types: image/jpeg, image/png. Maximum file size: 500KB. Minimum file size: 100KB, 500x500 pixels

Id card verifications Response

Example Id card verifications Response - Success (Found)

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930027",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "ketapang",
  "address": "Alinda kencana blok E",
  "status": "COMPLETED",
  "is_found": true,
  "result": {
    "seflie_score": 100,
    "is_name_match": true,
    "is_birthdate_match": true,
    "is_birthplace_match": true,
    "is_address_match": true
    }
}

Example Id card verifications Response - Success (Not Found)

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930021",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "ketapang",
  "address": "Alinda kencana blok E",
  "status": "COMPLETED",
  "is_found": false
}

Example Id card verifications Response - Failure

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d2",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930021",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "ketapang",
  "address": "Alinda kencana blok E",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request.

Id card verifications Schema

Parameter Description
id string (required)
A unique identifier of the request
created string (required)
The receipt date of the request. ISO8601 timestamp in UTC
updated string (required)
The last updated date of the request. ISO8601 timestamp in UTC
id_card_number string (required)
The national identity card number as per the KTP card
name string (required)
Name of the individual as per the KTP card
birthdate string (optional)
Date of birth as shown on the KTP card
birthplace string (optional)
End-user’s birth place as shown on the KTP card
address string (optional)
End-user’s address as shown on the KTP card
address string (optional)
End-user’s address as shown on the KTP card
is_found boolean (optional)
Present if status is COMPLETED. Whether the NIK was found in Dukcapil’s database
result object (optional)
The validation result. Present if status is COMPLETED and is_found true
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR

Result Object Schema

Parameter Description
is_name_match boolean (required)
If the NIK was found, whether the name was an exact match with the record Dukcapil holds for this NIK
is_birthdate_match boolean (optional)
If the NIK was found, whether the date of birth was an exact match with the record Dukcapil holds for this NIK
is_birthplace_match boolean (optional)
If the NIK was found, whether the place of birth was an exact match with the record Dukcapil holds for this NIK
is_address_match boolean (optional)
If the NIK was found, whether the address was a fuzzy match with the record Dukcapil holds for this NIK
selfie_score number (required)
If the NIK was found, how similar the submitted selfie was with the image Dukcapil holds for this NIK

Id card verifications Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
INVALID_API_KEY
401
API key format is invalid
API_KEY_IS_NOT_LIVE_ERROR
403
The API key does not have the permission to perform this request
FILE_TOO_LARGE
413
Selfie image too large
FILE_TOO_SMALL
413
Selfie image too small
UNSUPPORTED_CONTENT_TYPE
415
Selfie image is of wrong file type
RATE_LIMIT_EXCEEDED
429
Rate Limit hit
SERVER_ERROR
500
The service is down or other errors

KTP Validator

Endpoint: Validate KTP details

POST https://api.iluma.ai/v0/identity/id_card_verifications

Example KTP Validation Request

curl https://api.iluma.ai/v0/identity/id_card_verifications \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -F 'name="penito kristian"' \
    -F 'id_card_number="3275031210930027"' \
    -F 'scope="DATA_VERIFICATION"' \
    -F 'birthdate="12-10-1991"' \
    -F 'birthplace="Ketapang"' \
    -F 'address="Alinda kencana blok E"' 

The KTP validator endpoint exists to help you check whether a given KTP or NIK number exists in official Indonesian Government records. In addition, if you pass in secondary details from the card we can verify whether these match with the official records.

Note that you should only use a live Production key. Development keys will return an INVALID_API_KEY error body.

KTP Validator Request

Parameter Description
name string (required)
Name of the individual as per the KTP card
Min - 2 characters, Max - 100 characters
id_card_number string (required)
The national identity card number as per the KTP card
scope string (required)
Please input DATA_VERIFICATION for KTP Validation
birthdate string (optional)
Date of birth as shown on the KTP card
Format DD-MM-YYYY string
birthplace string (optional)
End-user's birth place as shown on the KTP card
address string (optional)
End-user’s address as shown on the KTP card

KTP Validator Response

Example KTP Validation Response - Success (Found)

{
    "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
    "created": "2022-06-29T08:18:43.529Z",
    "updated": "2022-06-29T08:18:43.529Z",
    "id_card_number": "3275031210930027",
    "name": "penito kristian",
    "birthdate": "12-10-1990",
    "birthplace": "ketapang",
    "address": "Alinda kencana blok E",
    "status": "COMPLETED",
    "is_found": true,
    "result": {
        "is_name_match": true,
        "is_birthdate_match": false,
        "is_birthplace_match": false,
        "is_address_match": false
    }
}

Example KTP Validation Response - Success (Not Found)

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930021",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "ketapang",
  "address": "Alinda kencana blok E",
  "status": "COMPLETED",
  "is_found": false
}

Example KTP Validation Response - Failure

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d2",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930021",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "ketapang",
  "address": "Alinda kencana blok E",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request.

KTP Validation Schema

Parameter Description
id string (required)
A unique identifier of the request
created string (required)
The receipt date of the request. ISO8601 timestamp in UTC
updated string (required)
The last updated date of the request. ISO8601 timestamp in UTC
id_card_number string (required)
The national identity card number as per the KTP card
name string (required)
Name of the individual as per the KTP card
birthdate string (optional)
Date of birth as shown on the KTP card
birthplace string (optional)
End-user’s birth place as shown on the KTP card
address string (optional)
End-user’s address as shown on the KTP card
address string (optional)
End-user’s address as shown on the KTP card
is_found boolean (optional)
Present if status is COMPLETED. Whether the NIK was found in Dukcapil’s database
result object (optional)
The validation result. Present if status is COMPLETED and is_found true
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR

Result Object Schema

Parameter Description
is_name_match boolean (required)
If the NIK was found, whether the name was an exact match with the record Dukcapil holds for this NIK
is_birthdate_match boolean (optional)
If the NIK was found, whether the date of birth was an exact match with the record Dukcapil holds for this NIK
is_birthplace_match boolean (optional)
If the NIK was found, whether the place of birth was an exact match with the record Dukcapil holds for this NIK
is_address_match boolean (optional)
If the NIK was found, whether the address was a fuzzy match with the record Dukcapil holds for this NIK

KTP Validation Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
INVALID_API_KEY
401
API key format is invalid
API_KEY_IS_NOT_LIVE_ERROR
403
The API key does not have the permission to perform this request
RATE_LIMIT_EXCEEDED
429
Rate Limit hit
SERVER_ERROR
500
The service is down or other errors

ID Card OCR

Endpoint: Extract ID card details using OCR

POST https://api.iluma.ai/v1/identity/id_card_images

Example ID Card OCR Request

curl https://api.iluma.ai/v1/identity/id_card_images \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -F 'type="indonesia_ktp"' \
    -F 'image=@"/path/to/file.png"'
    -F 'reference_id="foo123"'

The ID card OCR endpoint exists to help you extract text and images from a photograph of an official Indonesian Government ID card. We recommend supplying photos which are in a standard landscape orientation, square-on to the camera and clearly focused for maximum effectiveness. We will clean and process any image you supply but the best method to ensure accurate OCR output is if you can control capture quality when obtaining the raw images.

ID Card OCR Request

Requests should be of type multi-part/form with the following content

Parameter Description
type string (required)
The type of ID being queried.
We currently support passport, indonesia_ktp (NIK) and npwp_card (NPWP) only
image file (required)
An ID photo of mime type image/png, image/bmp, image/jpeg. Maximum file size 2MB
reference_id string (optional)
Your identifier for this request. Providing this may help you to reconcile requests you make to our systems

ID Card OCR Response

Example ID Card OCR Response - Pending

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "PENDING",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Example ID Card OCR Response - Completed
NIK Example

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
    "idNumber": "1234567890123456",
    "name": "FIRA DIYANKA",
    "religion": "KRISTEN",
    "gender": "LAKI-LAKI",
    "birthPlaceBirthday": "JAKARTA,17-10-1975",
    "province": "JAWA TENGAH",
    "city": "KABUPATEN JEPARA",
    "district": "KELING",
    "village": "KELET",
    "rtrw": "015/004",
    "address":"JL. VETERAN GG. GARUDA NO.73D/34",
    "occupation": "KARYAWAN SWASTA",
    "expiryDate": "12-08-2016",
    "nationality": "WNI",
    "maritalStatus":"BELUM KAWIN"
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

NPWP Example

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "npwpId": "123456789123000",
        "address": null,
        "idNumber": null,
        "npwpName": "FIRA DIYANKA",
        "registrationOffice": null
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "npwp_card",
  "reference_id":"foo123"
}

Passport Example

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "gender": "Female",
        "country": "UNITED STATES OF AMERICA",
        "surname": "TRAVELER",
        "given_name": "HAPPY",
        "is_tampered": true,
        "date_of_birth": "1965-02-05T00:00:00.000Z",
        "date_of_issue": "2020-10-15T00:00:00.000Z",
        "date_of_expiry": "2030-10-14T00:00:00.000Z",
        "place_of_birth": "WASHINGTON, D.C.,U.S.A.",
        "passport_number": "E00007734",
        "issuing_authority": ""
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "passport",
  "reference_id":"foo123"
}

Example ID Card OCR Response - Completed with Unreadable ID Data

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Example ID Card OCR Response - Failure

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "status": "FAILED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "failure_reason": "IMAGE_RECOGNIZE_ERROR",
  "reference_id":"foo123"
}

You will receive a JSON response with an id on submitting the POST request. Because it may take a few seconds to upload and process the image file, all results are returned to you in a callback. Be sure to have a callback URL configured for ID card OCR in your account (Set it with type: ID_IMAGE_OCR_REQUEST). Please refer to Callback section for further details.

ID Card OCR Schema

Parameter Description
id string (required)
A unique identifier of the id card image request for use in later API calls
data json (optional)
The text content we have extracted from the ID card
status string (required)
The status of the OCR processing attempt
created string (required)
The receipt date of the OCR request. ISO8601 timestamp
updated string (required)
The last updated date of the OCR request. ISO8601 timestamp
type string (required)
The type of OCR request.
failure_reason string (optional)
The reason for the failure
reference_id string (optional)
The reference id of the user input

ID Card OCR Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
FILE_TOO_LARGE
413
The image is too large (> 2 MB, > 4096x4096 px. Please reduce image size before retrying.
UNSUPPORTED_CONTENT_TYPE
415
The file is in an unsupported format.
Only PNG, JPG, BMP are supported

ID Card OCR: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/id_card_images/:id

Example ID Card OCR: Get by id Request

curl https://api.iluma.ai/v1/identity/id_card_images/qwertyuiop1234567890 
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can inquire on the status of an existing request by making a GET request to the resource using the ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

ID Card OCR: Get by id Request

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique ID Card OCR request ID provided in our response at the time of resource creation

Example ID Card OCR Response - Pending

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "PENDING",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Example ID Card OCR Response - Completed
NIK Example

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
    "idNumber": "1234567890123456",
    "name": "FIRA DIYANKA",
    "religion": "KRISTEN",
    "gender": "LAKI-LAKI",
    "birthPlaceBirthday": "JAKARTA,17-10-1975",
    "province": "JAWA TENGAH",
    "city": "KABUPATEN JEPARA",
    "district": "KELING",
    "village": "KELET",
    "rtrw": "015/004",
    "address":"JL. VETERAN GG. GARUDA NO.73D/34",
    "occupation": "KARYAWAN SWASTA",
    "expiryDate": "12-08-2016",
    "nationality": "WNI",
    "maritalStatus":"BELUM KAWIN"
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

NPWP Example

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "npwpId": "123456789123000",
        "address": null,
        "idNumber": null,
        "npwpName": "FIRA DIYANKA",
        "registrationOffice": null
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "npwp_card",
  "reference_id":"foo123"
}

Passport Example

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "gender": "Female",
        "country": "UNITED STATES OF AMERICA",
        "surname": "TRAVELER",
        "given_name": "HAPPY",
        "is_tampered": true,
        "date_of_birth": "1965-02-05T00:00:00.000Z",
        "date_of_issue": "2020-10-15T00:00:00.000Z",
        "date_of_expiry": "2030-10-14T00:00:00.000Z",
        "place_of_birth": "WASHINGTON, D.C.,U.S.A.",
        "passport_number": "E00007734",
        "issuing_authority": ""
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "passport",
  "reference_id":"foo123"
}

Example ID Card OCR Response - Completed with Unreadable ID Data

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Example ID Card OCR Response - Failure

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "status": "FAILED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "failure_reason": "IMAGE_RECOGNIZE_ERROR",
  "reference_id":"foo123"
}

ID Card OCR: Get by Reference id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/id_card_images?reference_id=:reference_id&limit=:limit&after_id=:after_id

Example ID Card OCR: Get by Reference id Request

curl https://api.iluma.ai/v1/identity/id_card_images?reference_id=foo123
    -X GET \
    -u iluma_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:

You can inquire on the status of an existing request by making a GET request to the resource using the Reference ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

ID Card OCR: Get by Reference id Request

Parameter Description
reference_id string (required)
The reference_id of the request to retrieve. This reference_id is provided by the user
limit integer (optional)
The limit is number of records retrieved from the database. Default value is 10 records.
after_id string (optional)
This is provided from the response when there is excess records left based on the specified limit. This is to allow retrieval of your next set of records on the same Reference id.

ID Card OCR Get by Reference id Response Schema

Example of Get by Reference ID - Success Response

{
  "data":[{
    "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
    "data": {
      "idNumber": "1234567890123456",
      "name": "FIRA DIYANKA",
      "religion": "KRISTEN",
      "gender": "LAKI-LAKI",
      "birthPlaceBirthday": "JAKARTA,17-10-1975",
      "province": "JAWA TENGAH",
      "city": "KABUPATEN JEPARA",
      "district": "KELING",
      "village": "KELET",
      "rtrw": "015/004",
      "address":"JL. VETERAN GG. GARUDA NO.73D/34",
      "occupation": "KARYAWAN SWASTA",
      "expiryDate": "12-08-2016",
      "nationality": "WNI",
      "maritalStatus":"BELUM KAWIN"
    },
    "status": "COMPLETED",
    "created": "2021-02-19T06:50:25.619Z",
    "updated": "2021-02-19T06:50:25.619Z",
    "type": "indonesia_ktp",
    "reference_id":"foo123"
  }],
  "has_more": false,
  "links": [
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123",
          "rel": "first",
          "method": "GET"
      },
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123",
          "rel": "self",
          "method": "GET"
      }
  ]
}

Example of Get by Reference ID - Success Response with limit and after_id on response object

{
  "data":[{
    "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
    "data": {
      "idNumber": "1234567890123456",
      "name": "FIRA DIYANKA",
      "religion": "KRISTEN",
      "gender": "LAKI-LAKI",
      "birthPlaceBirthday": "JAKARTA,17-10-1975",
      "province": "JAWA TENGAH",
      "city": "KABUPATEN JEPARA",
      "district": "KELING",
      "village": "KELET",
      "rtrw": "015/004",
      "address":"JL. VETERAN GG. GARUDA NO.73D/34",
      "occupation": "KARYAWAN SWASTA",
      "expiryDate": "12-08-2016",
      "nationality": "WNI",
      "maritalStatus":"BELUM KAWIN"
    },
    "status": "COMPLETED",
    "created": "2021-02-19T06:50:25.619Z",
    "updated": "2021-02-19T06:50:25.619Z",
    "type": "indonesia_ktp",
    "reference_id":"foo123"
  }],
  "has_more": true,
  "links": [
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123",
          "rel": "first",
          "method": "GET"
      },
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123&limit=1",
          "rel": "self",
          "method": "GET"
      },
      {
            "rel": "next",
            "href": "/v1/identity/id_card_images?reference_id=foo123&limit=1&after_id=764d6583-6866-490d-b6c3-98f3de797d1b",
            "method": "GET"
      }
  ]
}

Example ID Card OCR Response - Reference id not found

{
  "data":[],
  "has_more":false,
  "links": [
        {
            "href": "/v1/identity/id_card_images?reference_id=foo456",
            "rel": "first",
            "method": "GET"
        },
        {
            "href": "/v1/identity/id_card_images?reference_id=foo456",
            "rel": "self",
            "method": "GET"
        }
    ]
}
Parameter Description
data array (required)
Array of ID Card OCR Objects returned by the query. May be an empty array
has_more boolean (required)
Indicates whether there are more items to be queried with after_id of the last item from current result
links array (required)
Array of links used to process the request. It may include the link for the next set of records if has_more is set to true

Face Comparison

Endpoint: Compare the similarity of two faces

POST https://api.iluma.ai/v1/identity/face_comparisons

Example Face Comparison Request

curl https://api.iluma.ai/v2/identity/face_comparisons \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    --form 'image_one=@"image_one.jpg"' \
    --form 'image_one=@"image_two.jpg"' 

The Face Comparison endpoint exists to help you validate whether two photos are of the same person, such as a photo of their face (selfie) and a photo of their ID card. We will recognise the photo within the ID card, extract it and compare this to the second image. We split this into two images as we strongly advise against performing this check using a single photo for example, of a user holding their ID card, as typical photo capture by end-users results in ID cards which are small and poorly focused, reducing accuracy of further processing.

Face Comparison Request

Parameter Description
image_one file (required)
Image of the individual to use for face comparison
Supported mime types: image/jpeg, image/png, and image/bmp. Max Size 2MB.
image_two file (required)
Image of the individual to use for face comparison
Supported mime types: image/jpeg, image/png, and image/bmp. Max Size 2MB.

Face Comparison Response

Example Face Comparison Response - Success

{
  "status": "COMPLETED",
  "match_percentage": 97.5,
  "id": "5ba359137f94918d2b0cb8bb"
}

Example Face Comparison Response - Failure

{
  "status": "FAILED",
  "failure_reason": "No face detected in image",
  "id": "5ba359137f94918d2b0cb8bb"
}

You will receive a JSON response with a reference id on submitting the POST request.

Face Comparison Schema

Parameter Description
status string (required)
The status of the Face Comparison attempt
match_percentage number (optional)
The percentage similarity of the match
failure_reason string (optional)
Reason for failed result
id string (required)
A unique identifier of the request

Face Comparison Errors

Error Code Description
API_VALIDATION_ERROR
400
The response may be due to any of the following reasons: the image is in an unsupported format (only PNG, JPG/JPEG, BMP are supported), if any of the image is above 2MB, and if request is missing required parameters

CFT Individual

The CFT (Combating the Financing of Terrorism) Individual endpoint can be used to check if an individual is connected with terrorism or proliferating weapons of mass destruction based on a range databases. We currently support queries against:

CFT Request Schema - Individual

Endpoint: Query individual for potential matches on official cft databases

POST https://api.iluma.ai/v2/identity/cft/individual_data_requests

Example CFT Watchlist Check - Individual

curl https://api.iluma.ai/v2/identity/cft/individual_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "given_name": "Kim Kyong",
        "surname": "Ok",
        "publishers": ["PPATK", "UNSCR"],
        "score_threshold": 50
    }'

We use a fuzzy match algorithm on the data you provide to rank the profiles in each of the source lists. The minimum requirement is only given_name but the confidence in positive matches will be improved when you can provide us with as many data fields as possible to enrich the search.

Parameter Description
publishers array (optional)
An array of strings showing the lists you want to include in the search. Supported values are UNSCR, OFAC, PPATK, MAS and EC. If omitted, we will search all lists.
score_threshold integer (required)
The minimum score threshold below which we will filter results
given_name string (required)
The given name(s) that will be used for name matching purposes
middle_name string (optional)
Any known middle name(s) for the individual. If provided, these will increase our name matching performance
surname string (optional)
Any known surname(s) for the individual. If provided, these will increase our name matching performance
nationality string (optional)
The country of birth or citizenship of the individual. ISO 3166-2 country code
addresses array (optional)
Any known addresses (home or work) of the individual. Each address object should have the following format:
country ISO 3166-2 country code
street_line1 Line 1 of street address e.g., building name and apartment number
street_line2 Line 2 of street address e.g., street number and name
city City of address
province Province of address
state State of address
postal_code Zip or Postal code of address
category Address type HOME, WORK or PROVINCIAL. We support Provincial homes to differentiate when the individual has a week-day home address in a city and returns to a family home in the provinces on weekends or holidays
date_of_birth string (optional)
YYYY-MM-DD formatted string
phone_number string (optional)
Mobile number of the individual in E.164 format
email string (optional)
Email address of the individual

Example CFT Watchlist Response - Individual

{
    "id": "2ccdb5ff-1a2f-4cc3-9434-5fb8d3b1d11b",
    "given_name": "Kim Kyong",
    "surname": "Ok",
    "publishers": ["PPATK"],
    "results": [
        {
            "list": "LDP",
            "names": [
                "Kim Kyong Ok",
                "KIM KYONG OK"
            ],
            "score": 70,
            "publisher": "PPATK",
            "nationalities": [
                "KP"
            ],
            "record_data": {
                "pid": "north_korean_individual_33",
                "name": "KIM KYONG OK",
                "type": "INDIVIDUAL",
                "origin": "Proliferasi WMD",
                "aliases": [
                    "Kim Kyong Ok"
                ],
                "reference": "DPRKi.033",
                "nationality": "Democratic People's Republic of Korea",
                "country_code": "KP",
                "date_of_birth": "a) tahun 1937 \nb) tahun 1938",
                "place_of_birth": ""
            },
            "dates_of_birth": [
                {
                    "d": 0,
                    "m": 0,
                    "y": 1937
                },
                {
                    "d": 0,
                    "m": 0,
                    "y": 1938
                }
            ]
        }
    ]
}

CFT Response Schema - Individual

A score will be returned along with your search results to help you prioritise your due diligence. Note that we do not provide recommendations with regard to the appropriateness of any specific similarity score. This API should be one component of your arsenal and is not a substitute for undertaking appropriate due diligence. The use of this API does not limit any criminal or civil liability for any act undertaken as a result of, or in reliance on, such use.

Parameter Description
id string (required)
Unique Response ID.
given_name string (required)
The given name of the individual submitted to the search.
middle_name string (optional)
The middle name of the individual submitted to the search.
surname string (optional)
The surname of the individual submitted to the search.
nationality string (optional)
The country of birth or citizenship of the individual submitted to the search.
addresses array (optional)
Individual's addresses submitted to the search.
date_of_birth string (optional)
Individual's date of birth submitted to the search.
phone_number string (optional)
Individual's mobile number submitted to the search.
email string (optional)
Individual's email address submitted to the search.
results array (required)
Array of result objects containing potential matches. May be an empty array.

Result Object Schema - Individual

Parameter Description
dates_of_birth array (optional)
Array of date of birth objects according to watchlist. Each object should have the following format:
y (required) 4 digit year
m (required) 1-2 digit month
d (required) 1-2 digit day
Partial dates will have values of 0 for the unknown components
list string (required)
Sub-list within the publisher (e.g., SDN vs Non-SDN for OFAC)
names array (required)
Concatenation of primary known name components on the list
nationalities array (optional)
Array of ISO 3166-2 country code strings of any known nationality of the individual
publisher string (required)
Publisher of the watchlist (e.g., OFAC)
record_data object (required)
The unmodified record from the watchlist publisher as a JSON object. Note that we do not guarantee the consistency of the schema within this object
score integer (required)
Numeric score suggesting a degree of similarity based on the search items

CFT Entity

The CFT (Combating the Financing of Terrorism) Entity endpoint can be used to check if an entity is connected with terrorism or proliferating weapons of mass destruction based on a range databases. We currently support queries against:

CFT Request Schema - Entity

Endpoint: Query entity for potential matches on official cft databases

POST https://api.iluma.ai/v2/identity/cft/entity_data_requests

Example CFT Watchlist Check - Entity

curl https://api.iluma.ai/v2/identity/cft/entity_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "business_name": "Yuk Tung Energy",
        "business_domicile": "SG",
        "publishers": ["PPATK", "UNSCR"],
        "score_threshold": 50
    }'

We use a similar fuzzy match algorithm to individuals but prioritise primary business identifiers instead. The minimum requirement is only business_name but the confidence in positive matches will be improved when you can provide us with as many data fields as possible to enrich the search.

Parameter Description
publishers array (optional)
An array of strings showing the lists you want to include in the search. Supported values are UNSCR, OFAC, PPATK, MAS and EC. If omitted, we will search all lists.
score_threshold integer (required)
The minimum score threshold below which we will filter results
business_name string (required)
The legal or trading name of the business that will be used for search
business_domicile string (optional)
The country of registration of the business entity, if known. ISO 3166-2 country code
addresses array (optional)
Any known addresses (home or work) of the business entity. Each address object should have the following format:
country (required)
ISO 3166-2 country code
street_line1 Line 1 of street address e.g., building name and apartment number
street_line2 Line 2 of street address e.g., street number and name
city City of address
province Province of address
state State of address
postal_code Zip or Postal code of address
category Address type REGISTERED or TRADING
date_of_registration string (optional)
YYYY-MM-DD formatted string
phone_number string (optional)
A contact phone number of the business entity in E.164 format
email string (optional)
A contact email address of the business entity

Example CFT Watchlist Response - Entity

{
    "id": "8ca9d4d4-b131-4ec3-92c0-7e9c124b919e",
    "business_name": "Yuk Tung Energy",
    "business_domicile": "SG",
    "publishers": ["UNSCR"],
    "results": [
        {
            "list": "UNSCR",
            "names": [
                "YUK TUNG ENERGY PTE LTD"
            ],
            "score": 80,
            "publisher": "UNSCR",
            "record_data": {
                "dataid": "6908689",
                "sort_key": "",
                "comments1": "Ship manager and commercial manager of the YUK TUNG, which conducted ship-to-ship transfer of refined petroleum product.",
                "list_type": {
                    "value": [
                        "UN List"
                    ]
                },
                "listed_on": "2018-03-30",
                "first_name": "YUK TUNG ENERGY PTE LTD",
                "versionnum": "1",
                "entity_alias": [
                    {
                        "quality": "",
                        "alias_name": ""
                    }
                ],
                "un_list_type": "DPRK",
                "entity_address": [
                    {
                        "city": "Singapore",
                        "street": "80 Raffles Place, #17-22 UOB Plaza",
                        "country": "Singapore",
                        "zip_code": "048624"
                    }
                ],
                "last_day_updated": {
                    "value": [
                        "2020-05-11"
                    ]
                },
                "reference_number": "KPe.075",
                "sort_key_last_mod": ""
            },
            "business_domiciles": [],
            "dates_of_registration": [
                {
                    "d": 0,
                    "m": 0,
                    "y": 0
                }
            ]
        }
    ]
}

CFT Response Schema - Entity

A score will be returned along with your search results to help you prioritise your due diligence. Note that we do not provide recommendations with regard to the appropriateness of any specific similarity score. This API should be one component of your arsenal and is not a substitute for undertaking appropriate due diligence. The use of this API does not limit any criminal or civil liability for any act undertaken as a result of, or in reliance on, such use.

Parameter Description
business_name string (required)
The name of the entity submitted to the search
business_domicile string (optional)
The domicile country submitted to the search
addresses array (optional)
The entity's addresses submitted to the search
date_of_registration string (optional)
The entity's date of registration submitted to the search
phone_number string (optional)
The contact phone number submitted to the search
email string (optional)
The contact email address submitted to the search
id string (required)
Unique Response ID
results array (required)
Array of result objects containing potential matches. May be an empty array

Result Object Schema - Entity

Parameter Description
business_domiciles array (optional)
ISO 3166-2 country code of the business on the watchlist
dates_of_registration array (optional)
Date of registration if available on the watchlist. Each object should have the following format:
y (required) 4 digit year
m (required) 1-2 digit month
d (required) 1-2 digit day
Partial dates will have values of 0 for the unknown components
list string (required)
Sub-list within the publisher (e.g., SDN vs Non-SDN for OFAC)
names array (required)
Best known business name on the list
publisher string (required)
Publisher of the watchlist (e.g., OFAC)
record_data object (required)
The unmodified record from the watchlist publisher as a JSON object. We do not guarantee the schema within this object
score integer (required)
Numeric score suggesting a degree of similarity based on the search items

CFT + PEP Individual

CFT + PEP Request Schema - Individual

This endpoint will let you submit a bundle of primary identifiers for an individual registering to your application. We will scan through global sanctions and politically exposed person lists to return a shortlist of possible matches to you so that you (or your automated decisioning system) can make determinations about whether to onboard the individual.

Endpoint: Perform individual CFT + PEP search

POST https://api.iluma.ai/v0/identity/individual_cft_peps

Example Request - Individual

curl https://api.iluma.ai/v0/identity/individual_cft_peps \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "given_names": "Maruf Amin",
        "user_id":"foo123",
        "nationality": "ID",
        "score_threshold": 90,
        "scopes": ["PEP_PRESENT"]
    }'
Parameter Description
reference_id string (optional)
Your identifier for this request
user_id string (required)
The unique user id for this individual in your systems
given_names string (required)
The given name(s) that will be used for name matching purposes
surname string (optional)
Any known surname(s) for the individual. If provided, these will increase our name matching performance
nationality string (required)
The country of birth or citizenship of the individual. ISO 3166-2 country code
addresses array (optional)
Any known addresses (home or work) of the individual. Each address object should have the following format:
country ISO 3166-2 country code
street_line1 Line 1 of street address e.g., building name and apartment number
street_line2 Line 2 of street address e.g., street number and name
city City of address
province Province of address
state State of address
postal_code Zip or Postal code of address
category Address type HOME, WORK or PROVINCIAL. We support Provincial homes to differentiate when the individual has a week-day home address in a city and returns to a family home in the provinces on weekends or holidays
date_of_birth string (optional)
YYYY-MM-DD formatted string
phone_number string (optional)
Mobile number of the individual in E.164 format
email string (optional)
Email address of the individual
gender string (optional)
The gender of the individual you are searching for. Supported values are FEMALE, MALE, OTHER
scopes array (required)
Specifies what scope of data sources will be searched using this endpoint. Supported values are PEP, SANCTION, OTHER. OTHER includes Monetary Authority of Singapore (MAS)
score_threshold integer (optional)
The minimum score threshold below which we will filter results. The minimum score allowed is 50, and the default score is 85 if not specified

Example Response - Individual

{
    "created": "2022-02-10T18:55:02.061Z",
    "updated": "2022-02-10T18:55:02.840Z",
    "id": "cftpi_05e27fc2-ac76-4307-9f46-36179abb7a6d",
    "reference_id": null,
    "user_id": "foo123",
    "phone_number": null,
    "email": null,
    "addresses": [],
    "scopes": [
        "PEP_PRESENT"
    ],
    "score_threshold": 90,
    "status": "COMPLETED",
    "given_names": "Ma'ruf Amin",
    "surname": null,
    "nationality": "ID",
    "date_of_birth": null,
    "gender": null,
    "results": [
      {
          "id": "2dc667a4-d232-4d51-a561-631ce966fb2c",
          "names": [
              "Amin Ma'ruf",
              "Ma'ruf Amin"
          ],
          "score": 97,
          "scopes": [
              "OTHER",
              "PEP_PRESENT"
          ],
          "nationalities": [
              "ID"
          ],
          "dates_of_birth": [
              "1943-03-11"
          ]
      }
  ]
}

CFT Response Schema - Individual

Parameter Description
id string (required)
Our unique identifier of the request for use in later API calls
reference_id string (required)
Your reference id for this request. Will return null if not provided on resource creation
user_id string (required)
Your user id as supplied in the request.
given_names string (required)
The given name(s) that will be used for name matching purposes
surname string (required)
The surname you supplied in this request. Will return null if not provided on resource creation
nationality string (required)
The nationality you supplied in this request. Will return null if not provided on resource creation
addresses array (required)
The array of addresses you supplied in this request. Will return null if not provided on resource creation. Each address object should have the following format:
country ISO 3166-2 country code
street_line1 Line 1 of street address e.g., building name and apartment number
street_line2 Line 2 of street address e.g., street number and name
city City of address
province Province of address
state State of address
postal_code Zip or Postal code of address
category Address type HOME, WORK or PROVINCIAL. We support Provincial homes to differentiate when the individual has a week-day home address in a city and returns to a family home in the provinces on weekends or holidays
date_of_birth string (required)
The date of birth you supplied in this request. Will return null if not provided on resource creation
phone_number string (required)
The phone number you supplied in this request. Will return null if not provided on resource creation
email string (required)
The email you supplied in this request. Will return null if not provided on resource creation
gender string (required)
The array of addresses you supplied in this request. Will return null if not provided on resource creation
scopes array (required)
The array of scopes you supplied in this request. Will return our default search scope if not provided on resource creation
score_threshold integer (required)
The score threshold you supplied in this request. Will return our default setting if not provided on resource creation
status string (required)
The status of the request. Possible values: COMPLETED, FAILED
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR
results array (optional)
The validation result. Present if status is COMPLETED

Result Object Schema - Individual

Parameter Description
id string (required)
Our unique identifier for this profile
score integer (required)
The fuzzy match similarity between the search profile and this profile
names array (required)
Concatenation of primary known name components on the list
nationalities array (optional)
Array of ISO 3166-2 country code strings of any known nationality of the individual
dates_of_birth array (optional)
Array of date of birth objects according to watchlist. Each object should have the following format:
y (required) 4 digit year
m (required) 1-2 digit month
d (required) 1-2 digit day
Partial dates will have values of 0 for the unknown components
scopes array (required)
Array of databases on which the record was found. Possible values are the same as the enum for scopes when making a request.

CFT + PEP Individual: Get by id

Get individual CFT PEP search

POST https://api.iluma.ai/v0/identity/individual_cft_peps/:id

Example Request - Get Individual by id Request

curl https://api.iluma.ai/v0/identity/individual_cft_peps/cftpi_934b0e7e-2ae8-441d-86af-6304b74d504f \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:
Parameter Description
id string (required)
Request ID as provided in the response object

Example Response - Get Individual by id Request

{
    "created": "2022-02-10T18:55:02.061Z",
    "updated": "2022-02-10T18:55:02.840Z",
    "id": "cftpi_05e27fc2-ac76-4307-9f46-36179abb7a6d",
    "reference_id": null,
    "user_id": "foo123",
    "phone_number": null,
    "email": null,
    "addresses": [],
    "scopes": [
        "PEP_PRESENT"
    ],
    "score_threshold": 90,
    "status": "COMPLETED",
    "given_names": "Ma'ruf Amin",
    "surname": null,
    "nationality": "ID",
    "date_of_birth": null,
    "gender": null,
    "results": [
        {
            "id": "2dc667a4-d232-4d51-a561-631ce966fb2c",
            "names": [
                "Amin Ma'ruf",
                "Ma'ruf Amin"
            ],
            "score": 97,
            "scopes": [
                "OTHER",
                "PEP_PRESENT"
            ],
            "nationalities": [
                "ID"
            ],
            "dates_of_birth": [
                "1943-03-11"
            ]
      }
  ]
}

CFT + PEP Entity

CFT + PEP Request Schema - Entity

This endpoint will let you submit a bundle of primary identifiers for a business entity (Company, partnership etc) registering to your application. We will scan through global sanctions and politically exposed person lists to return a shortlist of possible matches to you so that you (or your automated decisioning system) can make determinations about whether to onboard the business entity. Note that PEP checks will be done against known directors and shareholders

Endpoint: Perform entity CFT + PEP search

POST https://api.iluma.ai/v0/identity/entity_cft_peps

Example Request - Entity

curl https://api.iluma.ai/v0/identity/entity_cft_peps \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "IBM Corporation",
        "user_id": "foo123",
        "business_domicile": "US",
        "score_threshold": 90,
        "scopes": ["PEP"]
    }'
Parameter Description
reference_id string (optional)
Your identifier for this request
user_id string (required)
The unique user id for this individual in your systems
name string (required)
Legal or trading name of the business
business_domicile string (required)
The country code of the business’ registration
addresses array (optional)
Array of objects containing any known addresses for the individual. Each object should have the following components:
country ISO 3166-2 country code
street_line1 Line 1 of street address e.g., building name and apartment number
street_line2 Line 2 of street address e.g., street number and name
city City of address
province Province of address
state State of address
postal_code Zip or Postal code of address
category Address type HOME, WORK or PROVINCIAL. We support Provincial homes to differentiate when the individual has a week-day home address in a city and returns to a family home in the provinces on weekends or holidays
date_of_registration string (optional)
Date of business registration if known
phone_number string (optional)
Mobile number of the individual
email string (optional)
Email address of the individual
scopes array (required)
Specifies what scope of data sources will be searched using this endpoint. Supported values are PEP, SANCTION, OTHER. OTHER includes Monetary Authority of Singapore (MAS)
score_threshold integer (optional)
The minimum score threshold below which we will filter results. The minimum score allowed is 50, and the default score is 85 if not specified

Example Response - Entity

{
    "created": "2022-02-17T21:17:49.917Z",
    "updated": "2022-02-17T21:17:50.712Z",
    "id": "cftpi_934b0e7e-2ae8-441d-86af-6304b74d504f",
    "reference_id": null,
    "user_id": "foo123",
    "addresses": [],
    "scopes": [
        "PEP"
    ],
    "score_threshold": 95,
    "status": "COMPLETED",
    "name": "intel",
    "business_domicile": "US",
    "results": [
        {
            "id": "ed84802c-d73d-4d22-8897-5bc771709073",
            "score": 100,
            "names": [
                "Intel Corp",
                "Intel Corporation"
            ],
            "business_domiciles": [
                "US"
            ],
            "scopes": [
                "OTHER",
                "PEP"
            ]
        }
    ]
}

CFT Response Schema - Entity

Parameter Description
id string (required)
Our unique identifier of the request for use in later API calls
reference_id string (required)
Your reference id for this request. Will return null if not provided on resource creation
user_id string (required)
Your user id as supplied in the request.
business_name string (required)
The name you supplied in this request.
business_domicile string (required)
The nationality you supplied in this request. Will return null if not provided on resource creation
addresses array (required)
The array of addresses you supplied in this request. Will return null if not provided on resource creation
date_of_registration string (required)
The date of birth you supplied in this request. Will return null if not provided on resource creation
phone_number string (required)
The phone number you supplied in this request. Will return null if not provided on resource creation
email string (required)
The email you supplied in this request. Will return null if not provided on resource creation
gender string (required)
The array of addresses you supplied in this request. Will return null if not provided on resource creation
scopes array (required)
The array of scopes you supplied in this request. Will return our default search scope if not provided on resource creation
score_threshold integer (required)
The score threshold you supplied in this request. Will return our default setting if not provided on resource creation
status string (required)
The status of the request. Possible values: COMPLETED, FAILED
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR
results array (optional)
The validation result. Present if status is COMPLETED

Result Object Schema - Entity

Parameter Description
id string (required)
Our unique identifier for this profile
score integer (required)
The fuzzy match similarity between the search profile and this profile
names array (required)
Concatenation of primary known name components on the list
business_domiciles array (optional)
Array of ISO 3166-2 country code strings of any known business registration countries
dates_of_registration array (optional)
Array of known registration date objects according to watchlist. Each object should have the following format:
y (required) 4 digit year
m (required) 1-2 digit month
d (required) 1-2 digit day
Partial dates will have values of 0 for the unknown components
scopes array (required)
Array of databases on which the record was found. Possible values are the same as the enum for scopes when making a request.

CFT + PEP Entity: Get by id

Endpoint: Get entity CFT PEP search

POST https://api.iluma.ai/v0/identity/entity_cft_peps/:id

Example Request - Get Entity by id Request

curl https://api.iluma.ai/v0/identity/entity_cft_peps/cftpi_934b0e7e-2ae8-441d-86af-6304b74d504f \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:
Parameter Description
id string (required)
Request ID as provided in the response object

Example Response - Get Entity by id Request

{
    "created": "2022-02-17T21:17:49.917Z",
    "updated": "2022-02-17T21:17:50.712Z",
    "id": "cftpi_934b0e7e-2ae8-441d-86af-6304b74d504f",
    "reference_id": null,
    "user_id": "foo123",
    "addresses": [],
    "scopes": [
        "PEP"
    ],
    "score_threshold": 95,
    "status": "COMPLETED",
    "name": "intel",
    "business_domicile": "US",
    "results": [
        {
            "id": "ed84802c-d73d-4d22-8897-5bc771709073",
            "score": 100,
            "names": [
                "Intel Corp",
                "Intel Corporation"
            ],
            "business_domiciles": [
                "US"
            ],
            "scopes": [
                "OTHER",
                "PEP"
            ]
        }
    ]
}

CFT + PEP Record: Get by id

Endpoint: Get CFT + PEP record

POST https://api.iluma.ai/v0/identity/cft_pep_listings/:id

Example Request - Get record by id

curl https://api.iluma.ai/v0/identity/entity_cft_peps/2dc667a4-d232-4d51-a561-631ce966fb2c \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:
Parameter Description
id string (required)
The ID as provided in the result from the search, i.e., body.results[x].id

Example Response - Get record by id

{
  "id": "2dc667a4-d232-4d51-a561-631ce966fb2c",
  "names": [
    "Amin Ma'ruf",
    "Ma'ruf Amin"
  ],
  "score": 97,
  "scopes": [
    "OTHER",
    "PEP_PRESENT"
  ],
  "nationalities": [
    "ID"
  ],
  "dates_of_birth": [
    "1943-03-11"
  ]
}

Business Document OCR

Endpoint: Extract Business Document OCR

POST https://api.iluma.ai/v1/identity/document_ocr_requests

Example Business Document OCR Request

curl --location --request POST 'localhost:8002/identity/v1/document_ocr_requests' \
    --form 'image=@"SK Menkeh .pdf"' \
    --form 'reference_id="foo123"' \
    --form 'type="BUSINESS_REGISTRATION"' \
    --form 'country="ID"' \
    --form 'document_name="SK_MENKEH"'

The Business Document OCR endpoint exists to help you extract text and images from a file of an official Business Document. We recommend supplying photos which are in a standard landscape orientation, square-on to the camera and clearly focused for maximum effectiveness. We will clean and process any image or file you supply but the best method to ensure accurate OCR output is if you can control capture quality when obtaining the raw images.

Business Document OCR Request

Requests should be of type multi-part/form with the following content

Parameter Description
reference_id string (required)
The user inputted reference ID
type string (required)
The type of Business Document being queried.
We currently support BUSINESS_REGISTRATION
image file (required)
The Business Document of mime type image/png, image/pdf, image/jpeg, image/jpg. Maximum file size 500MB
country string (required)
The country of Business Document being issued.
We currently support ID
document_name string (required)
The Document name of Business Document being queried.
We currently support SK_MENKEH

Business Document OCR Response

Example Business Document OCR Response - Pending

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-2ec00c2e-04a6-4836-871e-68185df17915",
    "created": "2022-02-25T06:56:20.808Z",
    "updated": "2022-02-25T06:56:20.808Z",
    "status": "PENDING",
    "result": {}
}

Example Business Document OCR Response - Completed
Business Document Example

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-32e6e523-6046-4db9-99ea-35a4f852ee86",
    "created": "2022-02-25T06:55:31.029Z",
    "updated": "2022-02-25T06:55:31.029Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": [
                    {
                        "value": "MATTHEW DAVID ROSA",
                        "confidence_level": 99.80309041341145
                    },
                    {
                        "value": "TIKA OSBOND SIRAIT",
                        "confidence_level": 99.58164469401042
                    },
                    {
                        "value": "SIVA SAJAN BHUPATHI RAJU",
                        "confidence_level": 99.03042030334473
                    }
                ]
            },
            {
                "name": "commisioner_names",
                "values": [
                    {
                        "value": "PANG SU KONG",
                        "confidence_level": 99.1666997273763
                    },
                    {
                        "value": "ANTHONY RICARD CATINELLA",
                        "confidence_level": 99.64801025390625
                    }
                ]
            },
            {
                "name": "shareholder_names",
                "values": [
                    {
                        "value": "METIS CONSULTANCY LIMITED",
                        "confidence_level": 99.80023193359375
                    },
                    {
                        "value": "WASPMOBILE SERVICES PRIVATE LIMITED",
                        "confidence_level": 99.5948486328125
                    }
                ]
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": "AHU-0049135.AH.01.01.TAHUN 2016",
                    "confidence_level": 79.09121704101562
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": "PT DIGITAL VISION PUBLISHING",
                    "confidence_level": 98.27043151855469
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "document_date",
                "values": {
                    "value": "03 November 2016",
                    "confidence_level": 99.49999237060547
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": "02",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": "BAHDER DJOHAN RAZAK,SH",
                    "confidence_level": 97.16451263427734
                }
            },
            {
                "name": "place_of_registration",
                "values": {
                    "value": "KOTA ADMINISTRASI JAKARTA SELATAN",
                    "confidence_level": 99.05745697021484
                }
            }
        ]
    }
}

Example Business Document OCR Response - Completed with Unreadable Business Document Data

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-98dd66b2-79e8-47f4-ae5a-3e7073a90f52",
    "created": "2022-02-25T06:55:56.085Z",
    "updated": "2022-02-25T06:55:56.085Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": []
            },
            {
                "name": "commisioner_names",
                "values": []
            },
            {
                "name": "shareholder_names",
                "values": []
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "establishment_place",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ]
    }
}

Example Business Document OCR Response - FAILED

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request. Because it may take a few seconds to upload and process the image file, all results are returned to you in a callback. Be sure to have a callback URL configured for Business Document OCR in your account (Set it with type: BUSINESS_DOCUMENT_OCR_REQUEST). Please refer to Callback section for further details.

Business Document OCR Schema

Parameter Description
id string (required)
A unique identifier of the Business Document image request for use in later API calls
reference_id string (optional)
An identifier of the Business Document image request that inputted by user
result json (required)
The text content we have extracted from the Business Document
status string (required)
The status of the OCR processing attempt
created string (required)
The receipt date of the OCR request. ISO8601 timestamp
updated string (required)
The last updated date of the OCR request. ISO8601 timestamp
type string (required)
The type of OCR request.
country string (required)
The country of Business Document being issued.
failure_reason string (optional)
The reason for the failure
document_name string (required)
The Document name of Business Document being queried

Result OCR Schema

Parameter Description
pages integer (required)
Extracted Business Document Pages
data array (required)
Extracted Business Document data

Business Document OCR Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
FILE_TOO_LARGE
413
The file is too large (> 500 MB. Please reduce file size before retrying.
UNSUPPORTED_CONTENT_TYPE
415
The file is in an unsupported format.
Only PNG, JPG, PDF, JPEG are supported

Business Document OCR: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/document_ocr_requests/:id

Example Business Document OCR: Get by id Request

curl https://api.iluma.ai/v1/identity/document_ocr_requests/qwertyuiop1234567890 
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can inquire on the status of an existing request by making a GET request to the resource using the ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Business Document OCR: Get by id Request

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique Business Document OCR request ID provided in our response at the time of resource creation

Example Business Document OCR Response - Pending

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-2ec00c2e-04a6-4836-871e-68185df17915",
    "created": "2022-02-25T06:56:20.808Z",
    "updated": "2022-02-25T06:56:20.808Z",
    "status": "PENDING",
    "result": {}
}

Example Business Document OCR Response - Completed
Business Document Example

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-32e6e523-6046-4db9-99ea-35a4f852ee86",
    "created": "2022-02-25T06:55:31.029Z",
    "updated": "2022-02-25T06:55:31.029Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": [
                    {
                        "value": "MATTHEW DAVID ROSA",
                        "confidence_level": 99.80309041341145
                    },
                    {
                        "value": "TIKA OSBOND SIRAIT",
                        "confidence_level": 99.58164469401042
                    },
                    {
                        "value": "SIVA SAJAN BHUPATHI RAJU",
                        "confidence_level": 99.03042030334473
                    }
                ]
            },
            {
                "name": "commisioner_names",
                "values": [
                    {
                        "value": "PANG SU KONG",
                        "confidence_level": 99.1666997273763
                    },
                    {
                        "value": "ANTHONY RICARD CATINELLA",
                        "confidence_level": 99.64801025390625
                    }
                ]
            },
            {
                "name": "shareholder_names",
                "values": [
                    {
                        "value": "METIS CONSULTANCY LIMITED",
                        "confidence_level": 99.80023193359375
                    },
                    {
                        "value": "WASPMOBILE SERVICES PRIVATE LIMITED",
                        "confidence_level": 99.5948486328125
                    }
                ]
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": "AHU-0049135.AH.01.01.TAHUN 2016",
                    "confidence_level": 79.09121704101562
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": "PT DIGITAL VISION PUBLISHING",
                    "confidence_level": 98.27043151855469
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "document_date",
                "values": {
                    "value": "03 November 2016",
                    "confidence_level": 99.49999237060547
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": "02",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": "BAHDER DJOHAN RAZAK,SH",
                    "confidence_level": 97.16451263427734
                }
            },
            {
                "name": "place_of_registration",
                "values": {
                    "value": "KOTA ADMINISTRASI JAKARTA SELATAN",
                    "confidence_level": 99.05745697021484
                }
            }
        ]
    }
}

Example Business Document OCR Response - Completed with Unreadable Business Document Data

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-98dd66b2-79e8-47f4-ae5a-3e7073a90f52",
    "created": "2022-02-25T06:55:56.085Z",
    "updated": "2022-02-25T06:55:56.085Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": []
            },
            {
                "name": "commisioner_names",
                "values": []
            },
            {
                "name": "shareholder_names",
                "values": []
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "establishment_place",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ]
    }
}

Example Business Document OCR Response - FAILED

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Business Document OCR: Get by Reference id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/document_ocr_requests?reference_id=:reference_id&after_id=:after_id&limit=:limit

Example Business Document OCR: Get by id Request

curl --location --request GET 'https://api.iluma.ai/v1/identity/document_ocr_requests?reference_id=foo123&after_id=ocr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20'

You can inquire on the status of an existing request by making a GET request to the resource using the ID and Reference ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Business Document OCR: Get by Reference id Request

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique Business Document OCR request ID provided in our response at the time of resource creation
reference_id string (required)
The reference_id of the request to retrieve. This reference_id is provided by the user
limit integer (required)
The limit is number of records retrieved from the database.

Example Business Document OCR Response - Pending

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-2ec00c2e-04a6-4836-871e-68185df17915",
    "created": "2022-02-25T06:56:20.808Z",
    "updated": "2022-02-25T06:56:20.808Z",
    "status": "PENDING",
    "result": {}
}

Example Business Document OCR Response - Completed
Business Document Example

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-32e6e523-6046-4db9-99ea-35a4f852ee86",
    "created": "2022-02-25T06:55:31.029Z",
    "updated": "2022-02-25T06:55:31.029Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": [
                    {
                        "value": "MATTHEW DAVID ROSA",
                        "confidence_level": 99.80309041341145
                    },
                    {
                        "value": "TIKA OSBOND SIRAIT",
                        "confidence_level": 99.58164469401042
                    },
                    {
                        "value": "SIVA SAJAN BHUPATHI RAJU",
                        "confidence_level": 99.03042030334473
                    }
                ]
            },
            {
                "name": "commisioner_names",
                "values": [
                    {
                        "value": "PANG SU KONG",
                        "confidence_level": 99.1666997273763
                    },
                    {
                        "value": "ANTHONY RICARD CATINELLA",
                        "confidence_level": 99.64801025390625
                    }
                ]
            },
            {
                "name": "shareholder_names",
                "values": [
                    {
                        "value": "METIS CONSULTANCY LIMITED",
                        "confidence_level": 99.80023193359375
                    },
                    {
                        "value": "WASPMOBILE SERVICES PRIVATE LIMITED",
                        "confidence_level": 99.5948486328125
                    }
                ]
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": "AHU-0049135.AH.01.01.TAHUN 2016",
                    "confidence_level": 79.09121704101562
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": "PT DIGITAL VISION PUBLISHING",
                    "confidence_level": 98.27043151855469
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "document_date",
                "values": {
                    "value": "03 November 2016",
                    "confidence_level": 99.49999237060547
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": "02",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": "BAHDER DJOHAN RAZAK,SH",
                    "confidence_level": 97.16451263427734
                }
            },
            {
                "name": "place_of_registration",
                "values": {
                    "value": "KOTA ADMINISTRASI JAKARTA SELATAN",
                    "confidence_level": 99.05745697021484
                }
            }
        ]
    }
}

Example Business Document OCR Response - Completed with Unreadable Business Document Data

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-98dd66b2-79e8-47f4-ae5a-3e7073a90f52",
    "created": "2022-02-25T06:55:56.085Z",
    "updated": "2022-02-25T06:55:56.085Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": []
            },
            {
                "name": "commisioner_names",
                "values": []
            },
            {
                "name": "shareholder_names",
                "values": []
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "establishment_place",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ]
    }
}

Example Business Document OCR Response - FAILED

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Passive Liveness Check

This endpoint will let you submit a selfie to perform passive liveness check on

Endpoint: Perform liveness checks

POST https://api.iluma.ai/v0/identity/liveness_checks

Example Request - Perform liveness checks

curl https://api.iluma.ai/v0/identity/liveness_checks \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -F 'reference_id="test_reference_id"' \
    -F 'image=@"/path/to/file.png"'
Parameter Description
reference_id string (optional)
The client’s unique ID for this request
selfie file (required)
Selfie image of the individual. Supported mime types: image/jpeg, image/png. Maximum file size: 500KB. Minimum file size: 100KB, 400x400 pixels

Example Response

{
  "id": "lvck_00df1710-8b06-4cd1-a32c-8f2b39cad6fe",
  "created": "2022-03-25T05:56:14.193Z",
  "updated": "2022-03-25T05:56:20.827Z",
  "reference_id": "test",
  "status": "COMPLETED",
  "confidence": 99,
  "is_live": true,
  "result": {
    "are_eyes_open": true,
    "is_face_cropped": false,
    "face_mask_detected": false,
    "multiple_faces_detected": true
  }
}

Response Schema

Parameter Description
id string (required)
A unique identifier of the document request for use in later API calls
reference_id string (required)
The client’s unique ID for this request. Will return null if NOT provided by the client in the request body
created string (required)
The receipt date of the OCR request. ISO8601 timestamp in UTC
updated string (required)
The last updated date of the OCR request. ISO8601 timestamp in UTC
status string (required)
Possible values: COMPLETED - processing completed successfully, FAILED - processing interrupted and/or fail at any stage
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR
is_live boolean (required)
Liveness check result. Present if status is COMPLETED
confidence number (required)
Confidence score on is_live flag. Present if status is COMPLETED
result object (optional)
Present if status is COMPLETED

Result Object Schema

Parameter Description
are_eyes_open boolean (required)
This parameter will detect if the eyes of the person clicking the selfie are open.
is_face_cropped boolean (required)
Enum: true or false. Whether face cropped in the image.
face_mask_detected boolean (required)
Enum: true or false. Whether a face mask was detected in the image
multiple_faces_detected boolean (required)
Enum: true or false. "true" when multiple prominent faces were found in the selfie.

ID Phone Validator

Endpoint: ID Phone Validator service

POST https://api.iluma.ai/v0/identity/ktp_phone_validations

Example ID Phone Validator Request

curl --location --request POST 'https://api.iluma.ai/v0/identity/ktp_phone_validations' \
--header 'Authorization: Basic e3thcGlrZXl9fTo=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123"
}'

The ID Phone Validator endpoint exists to help you check if a given Indonesian KTP or NIK is associated with a specific phone number.

ID Phone Validator Request

Parameter Description
id_card_number string (required)
The national identity card number as per the KTP card
phone string (required)
Phone Number Associated with ID Card number. Supported Formats: (+62xxx, 08xxx)
reference_id string (optional)
Reference ID from Clients

ID Phone Validator Response

Example ID Phone Validator Response - Completed (Found)

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "COMPLETED",
    "is_found": true,
    "result": {
        "is_phone_match": true,
        "count_phones_owned_by_id": 2
    }
}

Example ID Phone Validator Response - Completed (Not Found)

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "COMPLETED",
    "is_found": false
}

Example ID Phone Validator Response - Failure

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request.

ID Phone Validator Schema

Parameter Description
id string (required)
A unique identifier of the request
created string (required)
The receipt date of the request. ISO8601 timestamp in UTC
updated string (required)
The last updated date of the request. ISO8601 timestamp in UTC
id_card_number string (required)
The national identity card number as per the KTP card
phone string (required)
Phone Number Associated with ID Card number. Supported Formats: (+62xxx, 08xxx)
reference_id string (optional)
Reference ID from Clients
is_found boolean (optional)
Present if status is COMPLETED. Whether the NIK was found in Dukcapil’s database
result object (optional)
The validation result. Present if status is COMPLETED and is_found true
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR

Result Object Schema

Parameter Description
is_phone_match boolean (required)
If the NIK was found, whether the phone number was an exact match with the record Dukcapil holds for this NIK
count_phones_owned_by_id integer (required)
If the NIK was found, count how many phone numbers associated with the id card

ID Phone Validator Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
INVALID_API_KEY
401
API key format is invalid
API_KEY_IS_NOT_LIVE_ERROR
403
The API key does not have the permission to perform this request
RATE_LIMIT_EXCEEDED
429
Rate Limit hit
SERVER_ERROR
500
The service is down or other errors

ID Phone Validator: Get by ID Request

GET https://api.iluma.ai/v1/identity/ktp_phone_validations/:id

Example ID Phone Validator: Get by id Request

curl --location --request GET 'https://api.iluma.ai/v1/identity/ktp_phone_validations/123
Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique ID Phone Validator Validation request ID provided in our response at the time of resource creation

Example ID Phone Validator Validation Response - Pending

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "PENDING"
}

Example ID Phone Validator Response - Completed

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "COMPLETED",
    "is_found": true,
    "result": {
        "is_phone_match": true,
        "count_phones_owned_by_id": 2
    }
}

Example ID Phone Validator Response - Completed (Not Found)

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "COMPLETED",
    "is_found": false
}

Example ID Phone Validator Response - Failure

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

ID Phone Validator: Get by Reference id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/ktp_phone_validations?reference_id=:reference_id&after_id=:after_id&limit=:limit

Example ID Phone Validator: Get by Reference id Request

curl --location --request GET 'https://api.iluma.ai/v1/identity/ktp_phone_validations?reference_id=foo123&after_id=idcpv-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20'

You can inquire on the status of an existing request by making a GET request to the resource using the ID and Reference ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

ID Phone Validator: Get by Reference id Request

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique ID Phone Validator Validation request ID provided in our response at the time of resource creation
reference_id string (required)
The reference_id of the request to retrieve. This reference_id is provided by the user
limit integer (required)
The limit is number of records retrieved from the database.

Example ID Phone Validator Response - Pending

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "PENDING"
}

Example ID Phone Validator Response - Completed

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "COMPLETED",
    "is_found": true,
    "result": {
        "is_phone_match": true,
        "count_phones_owned_by_id": 2
    }
}

Example ID Phone Validator Response - Completed (Not Found)

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "COMPLETED",
    "is_found": false
}

Example ID Phone Validator Response - Failure

{
    "id_card_number": "3742231234562121",
    "phone": "0812511123232",
    "reference_id": "foo-123",
    "id": "idcpv-c507b750-896c-4aca-b323-ac08b550b698",
    "created": "2022-05-30T08:14:41.149Z",
    "updated": "2022-05-30T08:14:41.149Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Document OCR Capture

Endpoint: Retrieve capture link for Document OCR

POST https://api.iluma.ai/v1/identity/document_ocr_captures

Example Business Document OCR Request

curl https://api.iluma.ai/v1/identity/document_ocr_captures \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
       "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
        "country": "PH",
        "reference_id": "1234",
    }'

This service allows you to request for a unique GUI link (one-time use) where your users can upload their KYC documents (Identity Card, Selfie, Business Registration Document). We will perform OCR extraction on the provided documents, liveness check on the Selfie, facial comparison between the Identity Card and the Selfie, and return all these results in a callback payload to you.


This service is currently only available in the Philippines.


The full workflow can be seen in this diagram, detailing out the point of interactions that you will need to integrate with, and further details on each endpoint is subsequently provided.

Document OCR Capture Request

Parameter Description
types array (required)
The type of document for OCR. Possible values IDENTITY_CARD, BUSINESS_REGISTRATION, SELFIE
country string (optional)
The country of document for OCR. Possible values PH (default if absent). Format ISO3166-2 country code
reference_id string (optional)
The client’s unique ID for this request

Document OCR Capture Response

Example Document OCR Capture Response - PENDING

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "PENDING",
    "capture_link": "www.iluma.ai"
}

Example Document OCR Capture Response - IN_PROGRESS

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "IN_PROGRESS",
    "capture_link": "www.iluma.ai"
}

Example Document OCR Capture Response - COMPLETED_REVIEW_REQUIRED

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "COMPLETED_REVIEW_REQUIRED",
    "capture_link": "www.iluma.ai",
    "result": {
        "id_card_ocr": {
            "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
            "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
            "gender": "M",
            "address": "Street 17",
            "country": "PH",
            "surname": "Test",
            "given_name": "Test name",
            "is_tampered": false,
            "date_of_birth": "1985-02-03",
            "date_of_issue": "2018-06-20",
            "document_name": "Driver’s Licence",
            "date_of_expiry": "2027-06-19",
            "id_card_number": "P1111111A",
            "place_of_birth": "SASMUAN PAMPANGA"
        },
        "selfie": {
            "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
            "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
            "are_eyes_open": true,
            "face_mask_detected": false,
            "is_face_cropped": false,
            "multiple_faces_detected": false,
            "is_live": true,
            "confidence": 99,
            "document_name": "Selfie"
        },
        "face_match_percentage": {
            "is_a_match": false,
            "match_score": 0.38
        },
        "business_registration_ocr": {
            "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
            "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
            "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
            "is_tampered": false,
            "business_name": "Testcompany LLC",
            "date_of_issue": "2018-05-03",
            "document_name": "Any Document",
            "date_of_expiry": "2028-05-03",
            "business_owner_name": "John Bold",
            "registration_number": "1111111",
            "date_of_registration": "2018-05-03"
        }
    }
}

Example Document OCR Capture Response - COMPLETED

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "COMPLETED",
    "capture_link": "www.iluma.ai",
    "result": {
        "id_card_ocr": {
            "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
            "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
            "gender": "M",
            "address": "Street 17",
            "country": "PH",
            "surname": "Test",
            "given_name": "Test name",
            "is_tampered": false,
            "date_of_birth": "1985-02-03",
            "date_of_issue": "2018-06-20",
            "document_name": "Driver’s Licence",
            "date_of_expiry": "2027-06-19",
            "id_card_number": "P1111111A",
            "place_of_birth": "SASMUAN PAMPANGA"
        },
        "selfie": {
            "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
            "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
            "are_eyes_open": true,
            "face_mask_detected": false,
            "is_face_cropped": false,
            "multiple_faces_detected": false,
            "is_live": true,
            "confidence": 99,
            "document_name": "Selfie"
        },
        "face_match_percentage": {
            "is_a_match": false,
            "match_score": 0.38
        },
        "business_registration_ocr": {
            "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
            "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
            "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
            "is_tampered": false,
            "business_name": "Testcompany LLC",
            "date_of_issue": "2018-05-03",
            "document_name": "Any Document",
            "date_of_expiry": "2028-05-03",
            "business_owner_name": "John Bold",
            "registration_number": "1111111",
            "date_of_registration": "2018-05-03"
        }
    }
}

Example Document OCR Capture Response - FAILED

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request. Because it may take a few seconds to upload and process the image file, all result are returned to you in a callback. Be sure to have a callback URL configured for Document OCR Capture in your account (Set it with type: DOCUMENT_OCR_CAPTURE_REQUEST). Please refer to Callback section for further details.

Document OCR Capture Schema

Parameter Description
id string (required)
A unique identifier of the document request for use in later API calls
reference_id string (optional)
The client’s unique ID for this request
result json (optional)
Present if status is COMPLETED or COMPLETED_REVIEW_REQUIRED. Object of either id_card_ocr object, selfie object, face_match_percentage object or business_registration_ocr objects e.g.,
status string (required)
Capture process. Possible values: IN_PROGRESS - capture flow has finished and ocr has not completed, COMPLETED - flow has finished and ocr is completed, COMPLETED_REVIEW_REQUIRED - flow has finished, but additional review is needed,FAILED - flow interrupted and/or fail at any stage,
created string (required)
The receipt date of the OCR request. ISO8601 timestamp
updated string (required)
The last updated date of the OCR request. ISO8601 timestamp
types array (required)
The type of document for OCR. Possible values IDENTITY_CARD, BUSINESS_REGISTRATION, SELFIE
country string (required)
The country of document for OCR. Possible values PH
failure_reason string (optional)
The reason for the failure
capture_link string (required)
URL to the capture UI

id_card_ocr Schema

Parameter Description
id string (required)
A unique identifier for each document uploaded
document_name string (required)
Passport, Driver’s Licence, UMID, PhilSys, etc
link string (required)
link to the document captured
id_card_number string (required)
The identity card number extracted
given_name string (required)
Name of card holder (full_name if not able to split)
surname string (optional)
Surname
date_of_birth string (required)
Date of Birth. Format YYYY-MM-DD
gender string (required)
Gender. Possible values: M for Male, F for Female
date_of_expiry string (optional)
Date of Expiry
address string (optional)
Address as shown on the identity card.
country string (required)
The issuing country of the document. ISO3166-2 country code.
date_of_issue string (required)
Date of Issue
place_of_birth string (required)
Place of Birth
is_tampered boolean (required)
Whether doc have been tampered with

Selfie object

Payload if types include IDENTITY_CARD

Parameter Description
id string (required)
A unique identifier for each document uploaded
document_name string (required)
Selfie
link string (required)
link to the document captured
are_eyes_open boolean (required)
This parameter will detect if the eyes of the person clicking the selfie are open.
is_face_cropped boolean (required)
Whether face cropped in the image.
face_mask_detected boolean (required)
Whether a face mask was detected in the image.
multiple_faces_detected boolean (required)
Whether multiple prominent faces were found in the selfie.
is_live boolean (required)
Liveness check result
confidence string (required)
Confidence score on is_live flag

Face match percentage object

Payload if types include IDENTITY_CARD & SELFIE

Parameter Description
is_a_match boolean (required)
Whether the selfie is match with face in given identity document
match_score number (required)
Score of match percentage

business_registration_ocr Schema

Parameter Description
id string (required)
A unique identifier for each document uploaded
document_name string (required)
DTI, GIS, any other doc type
trn_number string (optional)
TRN number if document_name is DTI
link string (required)
link to the document captured
registration_number string (required)
The business registration number extracted
business_name string (required)
Name of card holder (full_name if not able to split)
date_of_registration string (required)
Date of registration. Format YYYY-MM-DD
date_of_expiry string (optional)
Date of Expiry
address string (optional)
Address as shown on the document.
country string (required)
The issuing country of the document. ISO3166-2 country code.
date_of_issue string (required)
Date of Issue
business_owner_name string (required)
name of business owner
is_tampered boolean (required)
Whether doc have been tampered with

Document OCR Capture Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
SERVER_ERROR
500
The service is down or other errors

Document OCR Capture: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/document_ocr_captures/:id

Example Document OCR Capture: Get by id Request

curl https://api.iluma.ai/v1/identity/document_ocr_captures/ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f
    -X GET \
    -u iluma_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:

You can inquire on the status of an existing request by making a GET request to the resource using the ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Document OCR Capture: Get by id Request

Parameter Description
id string (required)
The unique request ID being retrieved

Example Document OCR Capture Response

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "COMPLETED",
    "capture_link": "www.iluma.ai",
    "result": {
        "id_card_ocr": {
            "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
            "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
            "gender": "M",
            "address": "Street 17",
            "country": "PH",
            "surname": "Test",
            "given_name": "Test name",
            "is_tampered": false,
            "date_of_birth": "1985-02-03",
            "date_of_issue": "2018-06-20",
            "document_name": "Driver’s Licence",
            "date_of_expiry": "2027-06-19",
            "id_card_number": "P1111111A",
            "place_of_birth": "SASMUAN PAMPANGA"
        },
        "selfie": {
            "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
            "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
            "are_eyes_open": true,
            "face_mask_detected": false,
            "is_face_cropped": false,
            "multiple_faces_detected": false,
            "is_live": true,
            "confidence": 99,
            "document_name": "Selfie"
        },
        "face_match_percentage": {
            "is_a_match": false,
            "match_score": 0.38
        },
        "business_registration_ocr": {
            "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
            "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
            "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
            "is_tampered": false,
            "business_name": "Testcompany LLC",
            "date_of_issue": "2018-05-03",
            "document_name": "Any Document",
            "date_of_expiry": "2028-05-03",
            "business_owner_name": "John Bold",
            "registration_number": "1111111",
            "date_of_registration": "2018-05-03"
        }
    }
}

Document OCR Capture: Get by id - Errors

Error Code Description
DATA_NOT_FOUND
404
The request id requested does not exist
SERVER_ERROR
500
The service is down or other errors

Document OCR Capture: Get by Reference id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/document_ocr_capture?reference_id=:reference_id&after_id=:after_id&limit=:limit

Example Document OCR Capture: Get by id Request

curl --location --request GET 'https://api.iluma.ai/v1/identity/document_ocr_capture?reference_id=1234&after_id=ocr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20'

You can inquire on the status of an existing request by making a GET request to the resource using the ID and Reference ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Document OCR Capture: Get by Reference id Request

Parameter Description
reference_id string (required)
The reference_id of the request to retrieve. This reference_id is provided by the user
limit integer (optional)
The limit is number of records retrieved from the database. Defaults to 10
after_id string (optional)
The cursor for the start of the page

Example Document OCR Capture Response

{
    "data": [
        {
            "reference_id": "1234",
            "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
            "country": "PH",
            "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
            "created": "2022-04-06T07:33:32.106Z",
            "updated": "2022-04-06T07:33:32.106Z",
            "status": "COMPLETED",
            "capture_link": "www.iluma.ai",
            "result": {
                "id_card_ocr": {
                    "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
                    "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
                    "gender": "M",
                    "address": "Street 17",
                    "country": "PH",
                    "surname": "Test",
                    "given_name": "Test name",
                    "is_tampered": false,
                    "date_of_birth": "1985-02-03",
                    "date_of_issue": "2018-06-20",
                    "document_name": "Driver’s Licence",
                    "date_of_expiry": "2027-06-19",
                    "id_card_number": "P1111111A",
                    "place_of_birth": "SASMUAN PAMPANGA"
                },
                "selfie": {
                    "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
                    "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
                    "are_eyes_open": true,
                    "face_mask_detected": false,
                    "is_face_cropped": false,
                    "multiple_faces_detected": false,
                    "is_live": true,
                    "confidence": 99,
                    "document_name": "Selfie"
                },
                "face_match_percentage": {
                    "is_a_match": false,
                    "match_score": 0.38
                },
                "business_registration_ocr": {
                    "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
                    "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
                    "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
                    "is_tampered": false,
                    "business_name": "Testcompany LLC",
                    "date_of_issue": "2018-05-03",
                    "document_name": "Any Document",
                    "date_of_expiry": "2028-05-03",
                    "business_owner_name": "John Bold",
                    "registration_number": "1111111",
                    "date_of_registration": "2018-05-03"
                }
            }
        },
        {
            "id": "ocr-ecef7986-b9d6-4e50-8168-8b3d0b110262",
            "capture_link": "www.iluma.ai",
            "reference_id": "1234",
            "country": "PH",
            "types": [
                "IDENTITY_CARD"
            ],
            "status": "PENDING",
            "created": "2022-04-05T12:14:23.908Z",
            "updated": "2022-04-05T12:14:23.908Z"
        },
        {
            "id": "ocr-22bad02a-bbe9-4844-8959-6c50da197e60",
            "capture_link": "www.iluma.ai",
            "reference_id": "1234",
            "country": "PH",
            "types": [
                "IDENTITY_CARD"
            ],
            "status": "PENDING",
            "created": "2022-04-05T12:17:05.638Z",
            "updated": "2022-04-05T12:17:05.638Z"
        }
    ],
    "has_more": false,
    "links": [
        {
            "href": "/v1/document_ocr_captures?reference_id=1234",
            "rel": "first",
            "method": "GET"
        },
        {
            "href": "/v1/document_ocr_captures?reference_id=1234",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Document OCR Capture: Recapture Flow by id

Endpoint: Recapture Flow by id

GET https://api.iluma.ai/v1/identity/document_ocr_captures/:id/recapture

Example Document OCR Capture: Recapture Flow by id

curl https://api.iluma.ai/v1/identity/document_ocr_captures/ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f/recapture
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
       "types": ["IDENTITY_CARD"]
    }'

This endpoint will let you request a recapture on a Business document

Document OCR Recapture:

Path parameters Description
id string (required)
The unique request ID being retrieved
Body Description
types array (required)
The type of document for OCR. Possible values IDENTITY_CARD, BUSINESS_REGISTRATION, SELFIE

Example Document OCR Capture Response

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "RECAPTURE_PENDING",
    "capture_link": "www.iluma.ai"
}

Document OCR Recapture Errors

Error Code Description
DATA_NOT_FOUND
404
The request id requested does not exist
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
SERVER_ERROR
500
The service is down or other errors
Parameter Description
id string (required)
The unique request ID being retrieved
link string (required)
Link to the captured document

Endpoint: Download captured document using link

GET https://api.iluma.ai/v1/identity/captures/:id/results/:link
Error Code Description
DATA_NOT_FOUND
404
The request id requested does not exist
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
SERVER_ERROR
500
The service is down or other errors

Business Document Verification

Endpoint: Perform Business Document Verification

POST https://api.iluma.ai/v0/identity/business_document_verifications

Example Business Document Verification Request

curl https://api.iluma.ai/v0/identity/business_document_verifications \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
          "document_id": "ABC Shop",
          "document_id_type": "Business Name",
          "type": "DTI",
          "country": "PH",
          "reference_id": "test",
          "match_parameters": {
            "certificate_number": "1234567",
            "owner_name": "John Doe",
            "registration_date": "2022-01-01",
            "business_legal_name": "Shop ABC"
          }
        }'

The Business Document Verification endpoint allows validation of a DTI business registration document against official government databases. Please note that this endpoint only applies to Filipino businesses.

Business Document Verification Request

Parameter Description
document_id string (required)
Unique identifier of document provided
match_parameters object (required) MatchParameters
Parameters to be matched against the official database
document_id_type string
Type of document id provided.
Enum: Business Name(Default), Reference Code, TRN, PBN
type string
Type of document being validated country.
Enum: DTI(Default)
country string
The issuing country of the document.
Enum: PH(Default)
reference_id string
Customer identifier for this request

Match Parameters

Parameter Description
certificate_number string
Certificate number per DTI certificate / BNN
business_legal_name string
Business legal name per DTI certificate (if this is not used as document identifier)
owner_name string
Name of the business owner per DTI certificate.
registration_date string (date YYYY-MM-DD)
Registration date / date the DTI certificate is valid from.

Business Document Verification Response

Because it may take a few seconds to validate the business registration document against official government databases, all results are returned to you in a callback. Be sure to have a callback URL configured in your account (Set it with type: DTI_VALIDATION). Please refer to Callback section for further details.

Example Business Document Verification Response

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-a02c4549-69f6-4319-94fb-4c90c0d14082",
  "created": "2022-07-26T07:13:04.972Z",
  "updated": "2022-07-26T07:13:04.972Z",
  "status": "PENDING"
}

Document Verification Response

Parameter Description
id string (required)(bdvr-)
A unique identifier of the request for use in later API calls
created string (required)(date-time ISO8601)
The receipt date of the request. ISO8601 timestamp in UTC
updated string (required)(date-time ISO8601)
The last updated date of the request. ISO8601 timestamp in UTC
status string (required)
The status of the request.
Enum: PENDING, COMPLETED, FAILED
document_id string (required)
Unique identifier of document provided
document_id_type string (required)
Type of document id provided
type string (required)
Type of document being validated
country string (required)
The issuing country of the document
reference_id string
Customer identifier for this request
match_parameters object (required) MatchParameters
Parameters to be matched against the official database
is_found boolean
Present if status='COMPLETED', whether the document was found in official database
result object MatchParametersResult
The validation result, present if status='COMPLETED' and is_found=true

Match Parameters Result

Parameter Description
is_certificate_number_match boolean
Whether the certificate number was an exact match
is_registration_date_match boolean
Whether the registration date was an exact match
business_legal_name_score number
Whether the business legal name was a fuzzy match with the record for this DTI certificate
owner_name_score number
Whether the owner's name was a fuzzy match with the record for this DTI certificate

Business Document Verification Request Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
REQUEST_FORBIDDEN_ERROR
403
The API key lacks permissions for this endpoint

Business Document Verification : Get by id

Endpoint: Get Business Document Verification by request id

GET https://api.iluma.ai/v0/identity/business_document_verifications/:id

Example Business Document Verification: Get by request id

curl https://api.iluma.ai/v0/identity/business_document_verifications/qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

You can inquire on the status of an existing request by making a GET request to the resource using the id that is returned to you when creating the request resource. You will receive a response of the same format as shown in DocumentVerificationResponse.

Business Document Verification: Get by request id

Parameter Description
id string
The unique request ID being retrieved

Get Business Document Verification Response

Pending

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-a02c4549-69f6-4319-94fb-4c90c0d14082",
  "created": "2022-07-26T07:13:04.972Z",
  "updated": "2022-07-26T07:13:04.972Z",
  "status": "PENDING"
}

Completed (Found)

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-5a822398-904b-4bac-aae7-5275fa732d45",
  "created": "2022-07-26T07:12:54.932Z",
  "updated": "2022-07-26T07:12:54.932Z",
  "status": "COMPLETED",
  "is_found": true,
  "result": {
    "is_certificate_number_match": true,
    "is_registration_date_match": true,
    "owner_name_score": 100,
    "business_legal_name_score": 78
  }
}

Completed (Not Found)

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-54959185-9d32-43d3-9ef6-58ce7ea89487",
  "created": "2022-07-26T07:12:43.603Z",
  "updated": "2022-07-26T07:12:43.603Z",
  "status": "COMPLETED",
  "is_found": false
}

Failed

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-231cc051-7ced-453c-9349-7b3489c8e04f",
  "created": "2022-07-26T07:12:01.190Z",
  "updated": "2022-07-26T07:12:01.190Z",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Get Business Document Verification by ID Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
DATA_NOT_FOUND
404
The request id requested does not exist
REQUEST_FORBIDDEN_ERROR
403
The API key lacks permissions for this endpoint

Business Document Verification : Get by reference id

Endpoint: Get Business Document Verification by reference id

GET https://api.iluma.ai/v0/identity/business_document_verifications?reference_id=:reference_id&after_id=:after_id&limit=:limit

Example Business Document Verification: Get by reference id

curl https://api.iluma.ai/v0/identity/business_document_verifications?reference_id=foo123&after_id=bdvr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20\
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

You can inquire on the status of an existing request by making a GET request to the resource using the reference id given when creating the request resource. You will receive an array of DocumentVerificationResponse.

Business Document Verification: Get by reference id

Parameter Description
reference_id string
The client’s reference ID being retrieved
limit number
The number of results to return in a page. Defaults to 10
after_id string
The cursor for the start of the page. This refers to the request_id of the last request returned in previous page

Get Business Document Verification by Reference ID Response

{
  "data": [
    {
      "document_id": "ABC Shop",
      "document_id_type": "Business Name",
      "type": "DTI",
      "country": "PH",
      "reference_id": "test",
      "match_parameters": {
        "certificate_number": "1234567",
        "owner_name": "John Doe",
        "registration_date": "2022-01-01",
        "business_legal_name": "Shop ABC"
      },
      "id": "bdvr-5a822398-904b-4bac-aae7-5275fa732d45",
      "created": "2022-07-26T07:12:54.932Z",
      "updated": "2022-07-26T07:12:54.932Z",
      "status": "COMPLETED",
      "is_found": true,
      "result": {
        "is_certificate_number_match": true,
        "is_registration_date_match": true,
        "owner_name_score": 100,
        "business_legal_name_score": 78
      }
    }
  ],
  "has_more": true,
  "links": [
    {
      "href": "/v0/identity/business_document_verifications/",
      "rel": "first",
      "method": "GET"
    },
    {
      "href": "/v0/identity/business_document_verifications/?limit=10",
      "rel": "self",
      "method": "GET"
    },
    {
      "rel": "next",
      "href": "/v0/identity/business_document_verifications/?limit=10&after_id=653941f5-95d9-42d6-a40c-51c21e85b8d6",
      "method": "GET"
    }
  ]
}

Get Business Document Verification by Reference ID Response

Parameter Description
data array of DocumentVerificationResponse
An array of previously created requests found by reference_id provided. Will return an empty array if no resources are found.
links array of LinkSchema
HATEOAS implementation on after_id
has_more boolean
True if there are additional pages in the result

Parameter Description
href string
Target URI that should contain a target to Internationalized Resource Identifiers (IRI)
rel string
The link relation type described how the current context (source) is related to target
method string
HTTP method attributes for target IRI

Get Business Document Verification by Reference ID Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
REQUEST_FORBIDDEN_ERROR
403
The API key lacks permissions for this endpoint

Credit

Iluma's suite of credit products helps you to check the risk of an individual before advancing them credit. Iluma maintains consolidated credit tools including a range of individual data points which can be used to help you build your own credit models. We are continually building out our suite of credit data signals so contact us if you are interested in seeing something specific.

Bank Statement OCR

Endpoint: Extract Bank Statement OCR

POST https://api.iluma.ai/v1/credit/bank_statement_ocr_requests

Example Bank Statement OCR Request

curl --location --request POST 'https://api.iluma.ai/v1/credit/bank_statement_ocr_requests' \
    --form 'image=@"BRI.pdf"' \
    --form 'reference_id="foo123"' \
    --form 'type="BANK_STATEMENT"' \
    --form 'country="ID"' \
    --form 'bank_code="BRI"' \
    --form 'scope="BANK_OCR_TRANSACTIONS"'

The Bank Statement OCR endpoint exists to help you extract text and images from a file of an official Bank Statement. We recommend supplying photos which are in a standard landscape orientation, square-on to the camera and clearly focused for maximum effectiveness. We will clean and process any image or file you supply but the best method to ensure accurate OCR output is if you can control capture quality when obtaining the raw images.

Bank Statement OCR Request

Requests should be of type multi-part/form with the following content

Parameter Description
type string (required)
The type of Bank Statement being queried.
We currently support BANK_STATEMENT
image file (required)
The Bank Statement of mime type image/png, image/pdf, image/jpeg, image/jpg. Maximum file size 500MB
country string (required)
The country of Bank Statement being issued.
We currently support ID
bank_code string (required)
The Bank Code of Bank Statement being queried.
We currently support BRI, MANDIRI, BCA, BNI
scope string (required)
The scope of extraction.
We currently support BANK_OCR_TRANSACTIONS, BANK_OCR_METADATA

Bank Statement OCR Response

Example Bank Statement OCR Response - Pending

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-b0bb271a-403c-4a4a-80ea-1737127e5c48",
    "created": "2022-02-24T08:32:27.493Z",
    "updated": "2022-02-24T08:32:27.493Z",
    "status": "PENDING",
    "result": {}
}

Example Bank Statement OCR Response - Completed
Bank Statement Example

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-3338e53c-074c-43d1-adb3-417ace9a4943",
    "created": "2022-02-24T08:31:34.495Z",
    "updated": "2022-02-24T08:31:34.495Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "metadata": [
            {
                "name": "bank_code",
                "values": {
                    "value": "BRI",
                    "confidence_level": 90
                }
            },
            {
                "name": "bank_account_number",
                "values": {
                    "value": "01227723222",
                    "confidence_level": 70
                }
            },
            {
                "name": "bank_account_holder_name",
                "values": {
                    "value": "Rudy Hanso",
                    "confidence_level": 70
                }
            },
            {
                "name": "statement_date",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 65
                }
            },
            {
                "name": "bank_account_holder_address",
                "values": {
                    "value": "Jalan Jakarta No. 29",
                    "confidence_level": 55
                }
            }
        ],
        "transactions": []
    }
}

Example Bank Statement OCR Response - Completed with Unreadable Bank Statement Data

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-fe6e8298-31fd-4c60-90a5-7340ed55bf86",
    "created": "2022-02-24T08:28:29.871Z",
    "updated": "2022-02-24T08:28:29.871Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "metadata": [
            {
                "name": "bank_code",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_holder_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "statement_date",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_holder_address",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ],
        "transactions": []
    }
}

Example Bank Statement OCR Response - FAILED

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-3c918fee-6222-47bf-977a-9affbb4afbd1",
    "created": "2022-02-24T08:31:15.948Z",
    "updated": "2022-02-24T08:31:15.948Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request. Because it may take a few seconds to upload and process the image file, all results are returned to you in a callback. Be sure to have a callback URL configured for Bank Statement OCR in your account (Set it with type: BANK_STATEMENT_OCR_REQUEST). Please refer to Callback section for further details.

Bank Statement OCR Schema

Parameter Description
id string (required)
A unique identifier of the Bank Statement image request for use in later API calls
result json (required)
The text content we have extracted from the Bank Statement
status string (required)
The status of the OCR processing attempt
created string (required)
The receipt date of the OCR request. ISO8601 timestamp
updated string (required)
The last updated date of the OCR request. ISO8601 timestamp
type string (required)
The type of OCR request.
country string (required)
The country of Bank Statement being issued.
failure_reason string (optional)
The reason for the failure
bank_code string (required)
The Bank Code of Bank Statement being queried
scope string (required)
The scope of extraction

Result OCR Schema

Parameter Description
pages integer (required)
Extracted Bank Statement Pages
metadata array (required)
Extracted Bank Statement Metadata
transactions array (required)
Extracted Bank Statement Transactions (can be empty)

Bank Statement OCR Errors

Error Code Description
API_VALIDATION_ERROR
400
The request payload does not match what was specified. Missing form fields are provided in the response payload.
FILE_TOO_LARGE
413
The file is too large (> 500 MB. Please reduce file size before retrying.
UNSUPPORTED_CONTENT_TYPE
415
The file is in an unsupported format.
Only PNG, JPG, PDF, JPEG are supported

Bank Statement OCR: Get by id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/credit/bank_statement_ocr_requests/:id

Example Bank Statement OCR: Get by id Request

curl https://api.iluma.ai/v1/credit/bank_statement_ocr_requests/qwertyuiop1234567890 
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can inquire on the status of an existing request by making a GET request to the resource using the ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Bank Statement OCR: Get by id Request

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique Bank Statement OCR request ID provided in our response at the time of resource creation

Example Bank Statement OCR Response - Pending

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-b0bb271a-403c-4a4a-80ea-1737127e5c48",
    "created": "2022-02-24T08:32:27.493Z",
    "updated": "2022-02-24T08:32:27.493Z",
    "status": "PENDING",
    "result": {}
}

Example Bank Statement OCR Response - Completed
Bank Statement Example

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-3338e53c-074c-43d1-adb3-417ace9a4943",
    "created": "2022-02-24T08:31:34.495Z",
    "updated": "2022-02-24T08:31:34.495Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "metadata": [
            {
                "name": "bank_code",
                "values": {
                    "value": "BRI",
                    "confidence_level": 90
                }
            },
            {
                "name": "bank_account_number",
                "values": {
                    "value": "01227723222",
                    "confidence_level": 70
                }
            },
            {
                "name": "bank_account_holder_name",
                "values": {
                    "value": "Rudy Hanso",
                    "confidence_level": 70
                }
            },
            {
                "name": "statement_date",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 65
                }
            },
            {
                "name": "bank_account_holder_address",
                "values": {
                    "value": "Jalan Jakarta No. 29",
                    "confidence_level": 55
                }
            }
        ],
        "transactions": []
    }
}

Example Bank Statement OCR Response - Completed with Unreadable Bank Statement Data

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-fe6e8298-31fd-4c60-90a5-7340ed55bf86",
    "created": "2022-02-24T08:28:29.871Z",
    "updated": "2022-02-24T08:28:29.871Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "metadata": [
            {
                "name": "bank_code",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_holder_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "statement_date",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_holder_address",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ],
        "transactions": []
    }
}

Example Bank Statement OCR Response - FAILED

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-3c918fee-6222-47bf-977a-9affbb4afbd1",
    "created": "2022-02-24T08:31:15.948Z",
    "updated": "2022-02-24T08:31:15.948Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Bank Statement OCR: Get by Reference id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/credit/bank_statement_ocr_requests?reference_id=:reference_id&after_id=:after_id&limit=:limit

Example Bank Statement OCR: Get by id Request

curl --location --request GET 'https://api.iluma.ai/v1/credit/bank_statement_ocr_requests?reference_id=foo123&after_id=ocr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20'

You can inquire on the status of an existing request by making a GET request to the resource using the ID and Reference ID that is returned to you when creating the request resource. You will receive a response of the same format as shown in the response schemas above.

Bank Statement OCR: Get by Reference id Request

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique Bank Statement OCR request ID provided in our response at the time of resource creation
reference_id string (required)
The reference_id of the request to retrieve. This reference_id is provided by the user
limit integer (required)
The limit is number of records retrieved from the database.

Example Bank Statement OCR Response - Pending

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-b0bb271a-403c-4a4a-80ea-1737127e5c48",
    "created": "2022-02-24T08:32:27.493Z",
    "updated": "2022-02-24T08:32:27.493Z",
    "status": "PENDING",
    "result": {}
}

Example Bank Statement OCR Response - Completed
Bank Statement Example

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-3338e53c-074c-43d1-adb3-417ace9a4943",
    "created": "2022-02-24T08:31:34.495Z",
    "updated": "2022-02-24T08:31:34.495Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "metadata": [
            {
                "name": "bank_code",
                "values": {
                    "value": "BRI",
                    "confidence_level": 90
                }
            },
            {
                "name": "bank_account_number",
                "values": {
                    "value": "01227723222",
                    "confidence_level": 70
                }
            },
            {
                "name": "bank_account_holder_name",
                "values": {
                    "value": "Rudy Hanso",
                    "confidence_level": 70
                }
            },
            {
                "name": "statement_date",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 65
                }
            },
            {
                "name": "bank_account_holder_address",
                "values": {
                    "value": "Jalan Jakarta No. 29",
                    "confidence_level": 55
                }
            }
        ],
        "transactions": []
    }
}

Example Bank Statement OCR Response - Completed with Unreadable Bank Statement Data

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-fe6e8298-31fd-4c60-90a5-7340ed55bf86",
    "created": "2022-02-24T08:28:29.871Z",
    "updated": "2022-02-24T08:28:29.871Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "metadata": [
            {
                "name": "bank_code",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_holder_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "statement_date",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "bank_account_holder_address",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ],
        "transactions": []
    }
}

Example Bank Statement OCR Response - FAILED

{
    "reference_id": "foo123",
    "type": "BANK_STATEMENT",
    "country": "ID",
    "bank_code": "BRI",
    "scope": "BANK_OCR_TRANSACTIONS",
    "id": "ocr-3c918fee-6222-47bf-977a-9affbb4afbd1",
    "created": "2022-02-24T08:31:15.948Z",
    "updated": "2022-02-24T08:31:15.948Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Bank Statement OCR: Get Bank Statement OCR's Transactions in CSV by ID

Endpoint: Get Bank Statement OCR's transactions in CSV by ID

GET https://api.iluma.ai/v1/credit/bank_statement_ocr_requests/:id/transactions

Example Bank Statement OCR: Get Bank Statement OCR's Transactions CSV by ID

curl https://api.iluma.ai/v1/credit/bank_statement_ocr_requests/qwertyuiop1234567890/transactions
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

You can obtain the bank statement OCR's transactions in csv of an existing request by making a GET request to the resource using the ID that is returned to you when creating the request resource.

Bank Statement OCR: Get Bank Statement OCR's Transactions in CSV by ID

Parameter Description
id string (required)
The ID of the request to retrieve. This ID must match the unique Bank Statement OCR request ID provided in our response at the time of resource creation

Example Bank Statement OCR Transaction CSV response

"date","amount","description","is_credit","counterparty"
"2021-03-04",320079.48,"TRSF E-BANKI NG DB 0403/FTCCY/WS95051 574720000. 00  | TECH IN ",false,"TECHIN"
"2021-11-30",0.92,"PAJAK ",true,
"2021-12-30",50000,"TRSF E-BANKI NG DB 3012/FTCCY/WS95051 712950000. TECH IN",true,"TECHIN"
"2021-01-10",40000,"TRSF E-BANKI NG DB 1001/FTCCY/WS95051 573960000. TECH IN",true,"TECHIN"

Fraud

Iluma's fraud products help you to check the risk of an individual when they interact with you. We are building a range of individual data points which can be used to help you to identify fraudulent actors before they negatively affect your business, so contact us if you are interested in seeing something specific.

Bundled Identity Affirmation

Endpoint: Perform bundled identity affirmation for an individual

POST https://api.iluma.ai/v0/fraud/individual_risk_scores

Example Bundled Identity Fraud Risk Score Request

curl https://api.iluma.ai/v0/fraud/individual_risk_scores \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "reference_id": "foo123",
        "user_id": "bar123",
        "given_names": "FIRA DIYANKA",
        "surname": "FEBRIYANTI",
        "phone_number": "+6285300000000",
        "email": "fira@diyanka.com",
        "ip_addresses": [
            "101.50.2.165",
            "103.100.147.155"
        ],
        "device_fingerprint": {
            "device_id": "foo123",
            "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0",
            "screen_resolution": {"x":1920,"y":1280},
            "color_depth": 24,
            "languages": ["en-GB"],
            "device_memory": 8,
            "timezone": "Asia/Jakarta",
            "is_emulated": false,
            "is_app_cloned": false,
            "is_app_tampered": false,
            "is_gps_spoofed": false,
            "is_behind_vpn": false,
            "is_jailbroken": false,
            "is_factory_reset": false
        }
    }' \

This endpoint will let you submit a bundle of primary identifiers for an individual registering to your application. We will scan through our proprietary and third party data sources to return you a rich range of data signals that you can ingest into your risk model before making a decision on whether to continue business dealings with the end user.

Bundled Identity Affirmation Request

Parameter Description
reference_id string (optional)
Your identifier for this request
Min 5 characters, max 100 characters. Default null
user_id string (required)
The unique user id for this individual in your systems
given_names string (required)
Given names of the individual. Please supply this as per official national government ID
Min 2 characters, max 100 characters
surname string (optional)
Surname of the individual. Please supply this as per official national government ID. If surname is not known separately, put all names into the given_names field
Min 2 characters, max 100 characters. Default null
phone_number string (required)
The phone number of the individual being verified.
Format: E164
email string (required)
The email of the individual being verified.
Must be a valid email format i.e., recipient@domain
ip_addresses array of strings (optional)
Array of IPv4 address strings which the end user is using to register/interact with your application.
Format (\d{1,3}\.){3}\d{1,3}. Default empty array
device_fingerprint object (optional)
Object containing a device fingerprint with the following components from the fingerprint SDK:
session_id (string, required) The session ID returned by the fingerprinting SDK

As an alternative, you can manually construct a payload if you wish to use your own device fingerprinting, or fall back to basic browser identifiers which we will profile
device_id (string, optional) Your unique identifier for this device, if you do fingerprint resolution on your servers
user_agent (string, optional) User agent string for the browser on which the user is accessing the client website, in accordance with RFC7231
screen_resolution (object, optional) Screen resolution of the device. Format: {x:10,y:10}
color_depth (number, optional) Color depth of the device, in bits
languages (array of strings, optional) Array of language-region locales activated on the device, in RFC5646 format, e.g., [en-GB,zh-CN]
device_memory (number, optional) RAM of the device, in GB
timezone (string, optional) Timezone string for the device in IANA timezone format, e.g., Asia/Jakarta
is_emulated (boolean, optional) The device being used is emulated
is_app_cloned (boolean, optional) The app being used is cloned
is_app_tampered (boolean, optional) The app being used has been decompiled or otherwise tampered
is_gps_spoofed (boolean, optional) The device being used has GPS spoofing in use
is_behind_vpn (boolean, optional) The device being used is behind a VPN
is_jailbroken (boolean, optional) The device being used is jailbroken or rooted
is_factory_reset (boolean, optional) The device being used has been suspiciously factory reset

Bundled Identity Affirmation Response

Example Bundled Identity Affirmation Response

{
    "id": "indfd_f95ae802-4d96-4066-ada7-fe9487d4ca5e",
    "reference_id": "foo123",
    "user_id": "bar123",
    "created": "2021-02-19T06:50:25.619Z",
    "updated": "2021-02-19T06:50:25.619Z",
    "status": "COMPLETED",
    "given_names": "FIRA",
    "surname": "DIYANKA",
    "phone_number": "+62085300000000",
    "email": "fira@diyanka.com",
    "ip_addresses": [
        "101.50.2.165",
        "103.100.147.155"
    ],
    "device_fingerprint": {
        "session_id": "ee577243-399a-4859-8ea6-5e77e3bab571",
        "device_id": "ad6c2ab7-bcf4-414f-ac0c-b19b51e35524",
        "device_hash": "a03392a10c2f763a5a29cd55a9db7251",
        "is_emulated": false,
        "is_jailbroken_rooted": false
    },
    "result": {
        "fraud_score": 40,
        "is_email_disposable": true,
        "is_email_deliverable": true,
        "is_email_catchall": true,
        "number_of_queries_on_email": 4,
        "number_of_queries_on_phone": 3,
        "number_of_breaches": 2,
        "first_breach": "2018-07-05",
        "social_footprint":{
            "is_email_facebook_registered": true,
            "is_phone_facebook_registered": true,
            "is_email_instagram_registered": true,
            "is_phone_instagram_registered": true,
            "is_email_microsoft_registered": true,
            "is_phone_microsoft_registered": true,
            "is_email_yahoo_registered": true,
            "is_phone_yahoo_registered": true,
            "is_email_twitter_registered": true,
            "is_phone_twitter_registered": true,
            "is_phone_whatsapp_registered": true,
            "whatsapp_last_seen_at": "2021-02-19",
            "is_phone_telegram_registered": true,
            "telegram_last_seen_at": "2021-02-19",
            "is_email_airbnb_registered": true,
            "is_email_bookingcom_registered": true,
            "is_email_spotify_registered": true,
            "is_email_amazon_registered": true,
            "is_email_ebay_registered": true,
            "is_email_apple_registered": true,
            "is_email_linkedin_registered": true,
            "is_email_google_registered": true,
            "is_email_discord_registered": true,
            "is_email_skype_registered": true,
            "is_email_github_registered": true,
            "is_email_gravatar_registered": true,
            "is_email_pinterest_registered": true,
            "is_phone_snapchat_registered": true,
            "is_phone_line_registered": true,
            "is_phone_google_registered": true,
            "google_last_seen_at": null,
            "is_phone_viber_registered": true,
            "viber_last_seen_at": "2021-02-19",
            "is_email_disneyplus_registered": true,
            "is_email_netflix_registered": true,
            "is_email_jdid_registered": true,
            "is_email_bukalapak_registered": true,
            "is_email_lazada_registered": true,
            "is_email_zoho_registered": true,
            "is_email_samsung_registered": true,
            "is_email_patreon_registered": true,
            "is_email_tokopedia_registered": true,
            "is_email_quora_registered": true,
            "is_email_atlassian_registered": true,
            "is_phone_jdid_registered": true,
            "jdid_last_seen_at": "2021-02-19",
            "is_phone_bukalapak_registered": true,
            "bukalapak_last_seen_at": "2021-02-19"
        },
        "phone_activity":{
            "risk_category":0,
            "recency":"30_DAY",
            "current_status":"REACHABLE"
        },
        "payment_activity":{
            "is_found_by_email_or_phone": true,
            "is_found_by_name": true
        },
        "ip": {
            "country": "ID",
            "lat": -7.24917,
            "long": 112.75083,
            "is_tor": false,
            "is_harmful": false,
            "is_vpn": false,
            "is_web_proxy": false,
            "is_public_proxy": false
        }
    }
}

Bundled Identity Affirmation Schema

Parameter Description
created ISO8601 (required)
Time when you submitted the request.
Format: YYYY-MM-DDTHH:mm:ssZ Timezone: UTC+0
updated ISO8601 (required)
Time when the request was sent back to you.
Format: YYYY-MM-DDTHH:mm:ssZ. Timezone: UTC+0
id uuid (required)
Our unique identifier of the request for use in later API calls.
Format: indfd_{{uuid}}
reference_id string (optional)
Your identifier for this transaction as submitted in the request
user_id string (required)
The unique user id for this individual in your systems, as submitted in your request
given_names string (required)
Given names of the individual as submitted in your request
surname string (optional)
Surname of the individual as submitted in your request
phone_number string (required)
The phone number of the individual as submitted in your request
email string (required)
The email of the individual as submitted in your request
ip_addresses array of strings (required)
Array of IPv4 address strings as submitted in your request
device_fingerprint object (required)
Object containing the device fingerprint. If you supplied a session_id on resource creation, we will return an object with the most recently acquired device fingerprint as follows:
device_id (string, required) Device identifier based on self reported ID. E.g Android ID, GSF ID
device_hash (string, required) Entropy based device identifier, a hash of various device signals
is_emulated (string, required) If the SDK was run in an emulator
is_jailbroken_rooted (string, required) If the SDK was run on a jailbroken or rooted device
Will be an empty object if not provided in resource creation
status string (required)
The status of the request. Possible values: COMPLETED, FAILED
failure_reason string (optional)
The reason for the failure. Possible values: TEMPORARY_NETWORK_ERROR Our upstream data suppliers are down,TIMEOUT_ERROR Our upstream data suppliers failed to respond in a timely manner
result object (optional)
The validation result. Present if status is COMPLETED

Result Object Schema

Parameter Description
fraud_score number (required)
A rules based fraud score with weighted consideration for email/phone account registrations, phone activity and association to the payment network. Higher scores are more trustworthy
Min 0, max 100
is_email_disposable boolean (required)
A temporary email address from which emails are typically forwarded to standard email mailbox. Often used by fraudsters and spammers to generate fake accounts and generate fraudulent transactions
is_email_deliverable boolean (required)
This indicates whether the email address actually exists or not, using a fast SMTP-MX check
is_email_catchall boolean (required)
Catch-All domains always return a valid response from the SMTP service, whether the email address is actually valid or invalid
number_of_queries_on_email number (required)
An integer indicating the number of times the email address was queried
number_of_queries_on_phone number (required)
An integer indicating the number of times the phone number was queried
number_of_breaches number (required)
An integer indicating the number of times an email account has been breached
first_breach string (required)
First time when the email address was compromised. Format: YYYY-MM-DD.
number_of_duplicates string (required)
Number of duplicate devices. Possible values: 0,1-3,4-6,7-9,10+
social_footprint object (required)
The social footprint we are able to associate with the identity bundle:
is_email_{platform}_registered (boolean, required) Is the email address associated with an account on the quoted platform. Platforms: Facebook, Instagram, Microsoft, Yahoo, Twitter, Airbnb, Booking.com, Spotify, Amazon, Ebay, Apple, LinkedIn, Google, Discord, Skype, github, Gravatar, Pinterest, Disneyplus, Netflix, JD.id, Bukalapak, Lazada, Zoho, Samsung, Patreon, Tokopedia, Quora, Atlassian
is_phone_{platform}_registered (boolean, required) Is the phone number associated with an account on the quoted platform. Platforms: Facebook, Instagram, Microsoft, Yahoo, Twitter, Whatsapp, Telegram, Snapchat, Line, Google, Viber, JD.id, Bukalapak
{platform}_last_seen_at (date, required) When was the quoted platform account last active? Format: YYYY-MM-DD string. Default null. Platforms: Whatsapp, Telegram, Google, Viber, JD.id, Bukalapak
phone_activity object (required)
An object containing phone activity as seen by our partner network:
risk_category (number, required) Risk category based on the frequency of automated messaging activity to the phone number (e.g. OTP). Min 0 (Highly trusted), max 5 (Highly risky). Default null if cannot be classified
recency (string, required) Recency of automated messaging activity to this number, as seen by our partner network. Possible values:1_DAY,7_DAY,15_DAY,30_DAY,60_DAY,90_DAY,>90_DAY
current_status (string, required) A point in time check to assess whether the phone number is reachable. Possible values: REACHABLE,UNREACHABLE,UNAVAILABLE.
payment_activity object (required)
An object containing payment activity we could associate with this bundled identity:
is_found_by_email_or_phone (boolean, required) Was the phone number or email matched to a payment account in our payment gateway partner network (Bank account or E-Wallet)
is_found_by_name (boolean, required) Was the name matched (exact string match) to a name for a Bank account in our payment gateway partner network. Note an individual could have been mapped to more than one bank account
ip object (required)
An object containing details about the ip_addresses[0]:
country (string, required) IP country code. Uses the two- character ISO 3166-2 format.
lat (number, required) IP latitude
long (number, required) IP longitude
is_tor (boolean, required) It indicates whether the IP is TOR or not
is_harmful (boolean, required) It indicates whether an IP address is listed as harmful or not
is_vpn (boolean, required) It indicates whether the IP is a VPN or not
is_web_proxy (boolean, required) It indicates whether the IP is a web proxy or not
is_public_proxy (boolean, required) It indicates whether the IP is a public proxy or not

Errors

Below are some of most common errors across all our endpoints. Specific errors are located under each endpoint. If you have any questions please contact us.

Error code Meaning
400 Bad request, e.g. validation error, malformed payload
401 Unauthorised access, e.g. the API key is invalid
403 Forbidden access, e.g. API key does not have permission for this endpoint
404 Page or endpoint not found
413 The file is too large. Please refer to the api docs on the particular section for your endpoint to see the corresponding restrictions.
415 The file is in an unsupported format. Please refer to the api docs on the particular section for your endpoint to see the corresponding restrictions.
429 API rate limit exceeded. You should exponentially back off requests for this endpoint until you no longer receive this error state.
500 Unhandled error - contact us when this happens.
503 Service Unavailable - All upstream data suppliers are unavailable