Rate Limits

SmileID will track how many requests come in from a customer for a specific ID Number (within an ID Type). Excessive requests for the same ID Number over a period of time will cause us to block requests for this Number until the rate limit resets. Typically we see excessive requests for the same ID Number due to fraud or mis-configured integrations so we deny those excessive requests on behalf of our customers.

Our current rate limits per unique ID number are: a total of 30 requests, where each request comes within 3 days of each other. 3 days after a request comes in, the limit for that unique ID number will be reset. SmileID reserves the right to alter these limits as required at any time.

Blocked requests will receive a 429 response with the 2222 error code included in the body and This ID number has been blocked due to multiple submissions. Please use the designated endpoint to reactivate it. as the error message.

If you find genuine requests are being blocked then you can make a request to the id_number_rate_limit_reset endpoint to clear the rate limit and immediately allow requests for that ID Number to be processed normally.

ID Number Rate Limit Reset

POST https://testapi.smileidentity.com/v1/id_number_rate_limit_reset

Request Body

Name	Type	Description
timestamp	number	The timestamp used to create the signature
signature	string	The signature for the request
id_type	string	The id_type for the ID Number that you are wanting to reset the rate limit for
id_number	string	The id_number that you are wanting to reset the rate limit for
partner_id	string	Your 3 character partner_id which can be found in the portal

200

{
  "message": "Rate limit reset successful",
  "success": "true"
}

Example request

{
    "signature": "<Put calculated signature here>",
    "timestamp": "<Put timestamp here>",
    "partner_id": "<Put your partner_id here>",
    "id_type": "<ID type of the request>",
    "id_number": "<ID Number of the request>"
}

Response body fields

Name	Description
message	Will return as Rate limit reset successful if the rate limit was reset.
success	Will return as true if the rate limit was reset.

Possible Error Codes:

Code	Description
2401	System error