Understanding Response


IDMkyc seamlessly integrates with clients’ business websites & other gateway services. IDMkyc API offers optimal flexibility and reusability, and can easily be used to perform individual checks using multiple data-sources.

IDMkyc API returns a text/html response, which can be parsed in JSON. IDMkyc API uses HTTP response codes to indicate API errors (Refer to the HTTP Response Codes). As IDMkyc is connected with more than 400+ different data-sources, across more than 175+ countries, the supported parameters vary from country to country. Kindly refer to our Coverage Documentation to learn more about supported/accepted parameters for different APIs.


Sample Response Body

{"status":true,"status_code":200,"data":{"first_name":{"result":"Match"},"last_name":{"result":"Match"},"middle_name":{"result":"Match"},"dob":{"result":"Match"},"yob":{"result":"Match"},"gender":{"result":"Match"},"address":{"result":"Match"},"city":{"result":"Match"},"state":{"result":"Match"},"zip":{"result":"Match"},"phone":{"result":"Match"},"marital_status":{"result":"Match"}},"transaction_id":"1686837868648b1a6c598e8mTl8w","request_id":"00001"}

Sample Response Headers

content-type: text/html; charset=UTF-8

Possible Success Response

KeySupported or Expected Value type

status

true / false

status_code

data.first_name.result

Match / Partial Match / No Match / No Data

data.middle_name.result

Match / Partial Match / No Match / No Data

data.last_name.result

Match / Partial Match / No Match / No Data

data.dob.result

Match / Partial Match / No Match / No Data

data.gender.result

Match / No Match / No Data

data.address.result

Match / Partial Match / No Match / No Data

data.address1.result

Match / Partial Match / No Match / No Data

data.address2.result

Match / Partial Match / No Match / No Data

data.city.result

Match / Partial Match / No Match / No Data

data.state.result

Match / Partial Match / No Match / No Data

data.zip.result

Match / No Match / No Data

data.id_num.result

Match / Partial Match / No Match / No Data

data.phone.result

Match / No Match / No Data

data.email.result

Match / Partial Match / No Match / No Data

data.marital_status.result

Match / No Match / No Data

data.id_status.result

Match / No Match / No Data

request_id

Returns input values

transaction_id

IDMERIT tracking reference number

Last updated