Glossary
Supported Attributes
first_name
person's first-name
middle_name
person's middle-name
last_name
person's last-name
dob
person's date of birth in YYYY-MM-DD format
gender
person's gender in "m" or "f"
address
address line 1 & address line 2 of the individual
address1
address line 1 of the individual
address2
address line 2 of the individual
city
a valid city, district or locality
state
a valid state or province or region
zip
a valid zip or postal code
id_num
a valid individual document number
id_type
type of document number
phone
a valid phone number
a valid email address
marital_status
martial status of the individual (m for married, s for single)
id_status
type of document number status
request_id
a unique client reference number
Supported ID-Types
1
Passport
2
National ID
3
eID
4
Driver’s License
5
Residence Permit
6
Aadhaar Number (INDIA only)
7
TAX Number
8
SSN
9
4 Digit SSN Number (US Only)
Result Methodology
Matching methodology varies from APIs to APIs. However, IDMERIT has a standard threshold, based on which it derives results.
Match: String-Confidence Match score is more than 85%
Partial Match: String-Confidence Match score is less than 85% but more than 50%
No Match: String-Confidence Match score is less than 50%
No Data: No identifiable or match data or confidence score obtained from the source
No Input: Input request attribute is blank or null
Rate Limiting & Throttling Policy
To ensure the stability, security, and fair usage of the IDMkyc APIs, rate-limiting policies are implemented. These policies define the maximum number of requests that can be made to the API within a specified time window. Rate-limiting helps prevent abuse, maintain the quality of service, and provide a consistent experience for all users.
Rate Limiting Thresholds
Default rate limiting thresholds for the IDMkyc API is 1 RPS (Requests per seconds).
Exceeding Rate Limits
If a client exceeds the rate limits, the API will respond with a 429 - Too Many Requests HTTP status code, indicating that the client should reduce their request rate. Clients should implement rate limiting strategies on their side to ensure compliance with these limits.
Rate Limiting Best Practices
To avoid rate limiting issues and ensure optimal usage of the API, consider the following best practices:
Implement rate limiting on the client side to stay within the defined limits.
If your application requires higher rate limits, contact IDMERIT support to discuss custom rate limits or alternative solutions.
Last updated
Was this helpful?