Compliance
Get compliance requirements
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.
get/compliance/requirements
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
Requirements retrieved successfully
Example response
{
"status": true,
"data": {
"countryIso": "IN",
"numberType": "local",
"userType": "business",
"documentTypes": [
{
"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
}
]
}
]
}
}