Submit a compliance application

import requests
url = "https://api.smallest.ai/atoms/v1/compliance/applications"
files = { "files": "open('passport_scan.pdf', 'rb')" }
payload = {
    "countryIso": "US",
    "numberType": "mobile",
    "userType": "individual",
    "endUser": "{\"name\": \"John Doe\", \"country\": \"US\"}",
    "documents": "[{\"documentTypeId\": \"dt_456\", \"dataFields\": {\"first_name\": \"John\", \"last_name\": \"Doe\"}}]"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.json())

{
  "status": true,
  "data": {
    "_id": "663f1a2b4c5d6e7f8a9b0c1d",
    "organizationId": "org_789xyz123",
    "plivoComplianceId": "plivo_456def789",
    "alias": "663f1a2b-US-production",
    "status": "submitted",
    "countryIso": "US",
    "numberType": "mobile",
    "userType": "individual",
    "endUserName": "John Doe",
    "endUserLastName": "Doe",
    "endUserEmail": "john.doe@example.com",
    "endUserCountry": "US",
    "documentFileNames": [
      "passport_scan.pdf"
    ],
    "rejectionReason": "",
    "createdBy": "user_123abc456",
    "createdAt": "2024-04-10T11:45:00Z",
    "updatedAt": "2024-04-10T11:45:00Z"
  }
}

Submit a new compliance application with end-user details and supporting documents. One application is allowed per organization per country per number type per user type.

The request uses multipart/form-data because documents are uploaded inline. The endUser and documents fields are JSON strings embedded in the form data.

Authentication

AuthorizationBearer

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

Request

This endpoint expects a multipart form with multiple files.

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:

endUserstringRequired

JSON string containing end-user details. Example:

1 {
2   "name": "Acme Corp",
3   "country": "IN"
4 }

JSON string containing end-user details. Example: ```json { "name": "Acme Corp", "country": "IN" } ```

documentsstringRequired

JSON string containing an array of document metadata. Each entry must have a documentTypeId (from the requirements endpoint) and optional dataFields. Example:

1 [{"documentTypeId": "dt_123", "dataFields": {"business_name": "Acme Corp"}}]

JSON string containing an array of document metadata. Each entry must have a `documentTypeId` (from the requirements endpoint) and optional `dataFields`. Example: ```json [{"documentTypeId": "dt_123", "dataFields": {"business_name": "Acme Corp"}}] ```

filesfilesRequired

Document files in the same order as the documents metadata array. Accepted formats: PDF, JPEG, PNG. Maximum 5 MB per file, up to 10 files.

Response

Application submitted successfully

statusboolean

dataobject

A compliance application for a specific country, number type, and user type

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

500

Internal Server Error