Get compliance status

GET

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

GET

/atoms/v1/compliance/status

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/compliance/status"
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     "step": "submitted",
5     "application": {
6       "_id": "663f1a2b4c5d6e7f8a9b0c1d",
7       "organizationId": "org_9f8e7d6c5b4a3210",
8       "plivoComplianceId": "plv_1234567890abcdef",
9       "alias": "663f1a2b-IN-production",
10       "status": "submitted",
11       "countryIso": "IN",
12       "numberType": "local",
13       "userType": "business",
14       "endUserName": "Acme Corp",
15       "endUserLastName": null,
16       "endUserEmail": "compliance@acmecorp.com",
17       "endUserCountry": "IN",
18       "documentFileNames": [
19         "certificate_of_incorporation.pdf"
20       ],
21       "rejectionReason": null,
22       "createdBy": "user_5a6b7c8d9e0f1234",
23       "createdAt": "2024-01-15T09:30:00Z",
24       "updatedAt": "2024-01-20T14:45:00Z"
25     },
26     "requiredDocuments": [
27       {
28         "documentTypeId": "dt_certificate_of_incorporation",
29         "name": "Certificate of Incorporation",
30         "description": "A government-issued certificate proving business registration",
31         "proofRequired": true,
32         "requiredFields": [
33           {
34             "fieldName": "business_name",
35             "friendlyName": "Business Name",
36             "helpText": "Exact name as on the certificate",
37             "fieldType": "string",
38             "required": true
39           }
40         ]
41       }
42     ]
43   }
44 }

Returns the current compliance status for a given country, number type, and user type. This is the single endpoint the frontend uses to determine which step to render (form, submitted, accepted, rejected, expired, or suspended).

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

Compliance status retrieved successfully

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error