Submit a compliance application
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
API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.
Request
ISO 3166-1 alpha-2 country code
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 namelastName— last nameemail— email addressaddressLine1— street address line 1addressLine2— street address line 2city— citystate— state or provincepostalCode— postal/ZIP codecountry— ISO country code; defaults tocountryIsoif omittedregistrationNumber— business registration number (required for some business applications)
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"}}]
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.