Creating Requests


Pre-Requisites

IDMkyc offers a single API to access more than 400+ different sources across 175+ countries. To access this APIs, please make sure you have access to following items:

  • Developer Portal Credentials

  • A valid and approved Production or Sandbox Tier Subscription.

  • A valid Bearer Token


IDMkyc API URL Path

IDMkyc source-wise or API wise path could be found on "try-out" page under "Servers" tab.

Understanding API path:

Request Body

When using the POST method, parameters can be sent in the request body. Ensure that request body parameters are properly encoded and structured using the x-www-form-urlencoded Content-Type format.

Request cURL

IDMkyc portal can also generate a sample/test request cURL. Use the steps of Try-out API to generate a sample cURL.

Sample cURL

curl -X POST "https://gw.idmerit.com/us-1/2.1?first_name=CLFNAME&last_name=CLLNAME&middle_name=CLMNAME&dob=1995-
08-
01&yob=1995&gender=F&address=CLADDRESS%201&city=CLCITY&state=CLSTATE&zip=
9999&phone=8888888888&marital_status=M&request_id=00001" -H "accept: */*" 
-H "Authorization: Bearer j80*****-****-****-****-*********lja"

Sample Request URL

https://gw.idmerit.com/us-1/2.1?first_name=CLFNAME&last_name=CLLNAME&middle_name=CLMNAME&dob=1995-
08-
01&yob=1995&gender=F&address=CLADDRESS%201&city=CLCITY&state=CLSTATE&zip=
9999&phone=8888888888&marital_status=M&request_id=00001

Sample Sandbox Test

USA Source 1

post

Official Civil Register And Consumer Credit

Authorizations
Query parameters
first_namestringRequiredExample: CLFNAME
middle_namestringOptionalExample: CLMNAME
last_namestringRequiredExample: CLLNAME
dobstringOptionalExample: 1995-08-01
yobstringOptionalExample: 1995
genderstringOptionalExample: F
addressstringOptionalExample: CLADDRESS 1
citystringOptionalExample: CLCITY
statestringRequiredExample: CLSTATE
zipstringOptionalExample: 9999
phonestringOptionalExample: 8888888888
marital_statusstringOptionalExample: M
request_idstringRequiredExample: 0000-DOC-EXAMPLE-REQUEST
Responses
200
An example full-match response
text/html; charset=UTF-8
post
POST /us-1/2.1 HTTP/1.1
Host: gw.idmerit.com
Authorization: Bearer JWT
Accept: */*
200

An example full-match response

{
  "status": true,
  "status_code": 200,
  "data": {
    "first_name": {
      "result": "Match"
    },
    "middle_name": {
      "result": "Match"
    },
    "last_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": "17134337336620ec85bc9130NbFR",
  "request_id": "0000-DOC-EXAMPLE-REQUEST"
}
  • Ensure that all required parameters are included and formatted correctly according to the API's specifications.

  • Refer to the API country-wise API details for required and supported parameters, and expected responses.

Last updated

Was this helpful?