v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB
Compliance

Get compliance status

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).

get/compliance/status

Query parameters

countryIsostring required

ISO 3166-1 alpha-2 country code. Must be exactly 2 characters (e.g. "IN", "US"). Sending 3+ characters returns 400.

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

The type of phone number

userType'individual' | 'business' required

The type of end user

Response

Compliance status retrieved successfully

statusboolean

Example response

{
  "status": true,
  "data": {
    "step": "form",
    "application": {
      "_id": "663f1a2b4c5d6e7f8a9b0c1d",
      "alias": "663f1a2b-IN-production",
      "status": "submitted",
      "countryIso": "IN",
      "numberType": "local",
      "userType": "business",
      "endUserName": "Acme Corp",
      "endUserCountry": "IN",
      "documentFileNames": [
        "certificate_of_incorporation.pdf"
      ]
    },
    "requiredDocuments": [
      {
        "documentTypeId": "dt_certificate_of_incorporation",
        "name": "Certificate of Incorporation",
        "description": "A government-issued certificate proving business registration",
        "proofRequired": true,
        "requiredFields": [
          {
            "fieldName": "business_name",
            "friendlyName": "Business Name",
            "helpText": "Exact name as on the certificate",
            "fieldType": "string",
            "required": true
          }
        ]
      }
    ]
  }
}