Get compliance requirements

GET

https://api.smallest.ai/atoms/v1/compliance/requirements

GET

/atoms/v1/compliance/requirements

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/compliance/requirements"
4 
5 querystring = {"countryIso":"US","numberType":"mobile","userType":"individual"}
6 
7 payload = {}
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "requirementId": "req_us_mobile_individual_001",
5     "countryIso": "US",
6     "numberType": "mobile",
7     "userType": "individual",
8     "documentTypes": [
9       {
10         "documentTypeId": "dt_government_id",
11         "name": "Government Issued ID",
12         "description": "A valid government-issued photo identification document such as a passport or driver's license",
13         "proofRequired": true,
14         "requiredFields": [
15           {
16             "fieldName": "id_number",
17             "friendlyName": "ID Number",
18             "helpText": "The unique identification number on the document",
19             "fieldType": "string",
20             "required": true
21           },
22           {
23             "fieldName": "expiration_date",
24             "friendlyName": "Expiration Date",
25             "helpText": "The expiration date of the ID document",
26             "fieldType": "string",
27             "required": true
28           }
29         ]
30       }
31     ]
32   }
33 }

Discover what documents are required for a given country, number type, and user type. Results are cached for 1 hour. Returns an empty documentTypes array if no compliance is needed for the given combination.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

countryIsostringRequired=2 characters

ISO 3166-1 alpha-2 country code

numberTypeenumRequired

The type of phone number

Allowed values:

userTypeenumRequired

The type of end user

Allowed values:

Response

Requirements retrieved successfully

statusboolean

dataobject

Compliance requirements for a country/numberType/userType combination

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error