Compliance

Submit a compliance application

Changed on

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.

post/compliance/applications

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/compliance/applications
  • Auth
    HTTP bearer

Request body multipart/form-data

countryIsostring required

ISO 3166-1 alpha-2 country code

numberType'local' | 'mobile' | 'tollfree' required

The type of phone number

userType'individual' | 'business' required

The type of end user

endUserstring required

JSON-stringified end-user details. name is required; all other fields are optional but may be required by Plivo depending on country/numberType. Accepted fields:

  • name (required) — full name or business name
  • lastName — last name
  • email — email address
  • addressLine1 — street address line 1
  • addressLine2 — street address line 2
  • city — city
  • state — state or province
  • postalCode — postal/ZIP code
  • country — ISO country code; defaults to countryIso if omitted
  • registrationNumber — business registration number (required for some business applications)
documentsstring required

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

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

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.

Example request

{
  "countryIso": "IN",
  "numberType": "local",
  "userType": "business",
  "endUser": "{\"name\":\"Acme Corp\",\"email\":\"legal@acme.com\",\"addressLine1\":\"123 Main St\",\"city\":\"Mumbai\",\"state\":\"MH\",\"postalCode\":\"400001\",\"country\":\"IN\"}",
  "documents": "[{\"documentTypeId\": \"dt_123\", \"dataFields\": {\"business_name\": \"Acme Corp\"}}]"
}

Response

Application submitted successfully

statusboolean

Example response

{
  "status": true,
  "data": {
    "_id": "663f1a2b4c5d6e7f8a9b0c1d",
    "alias": "663f1a2b-IN-production",
    "status": "submitted",
    "countryIso": "IN",
    "numberType": "local",
    "userType": "business",
    "endUserName": "Acme Corp",
    "endUserCountry": "IN",
    "documentFileNames": [
      "certificate_of_incorporation.pdf"
    ]
  }
}

Changes

  • 17afe6179e3fRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

  • c3372c7e95abRevision changes
    • info

      endpoint added