Latest Legacy

Create a new compliance application

This API creates a compliance application.

API Endpoint

POST https://api.plivo.com/v1/Account/{auth_id}/ComplianceApplication/

Arguments

aliasstringrequired

Friendly name for the created compliance application.

end_user_idstringrequired

Unique identifier for the end user this application is mapped to.

compliance_requirement_idstringRequired

Unique identifier for the compliance requirement this application is mapped to.

document_idsList of Stringrequired

List of compliance documents mapped to this compliance application.

proof filerequired

Scanned proof supporting the provided information.

OR

aliasstringrequired

Friendly name for the compliance application.

end_user_idstringrequired

Unique identifier for the end user this application is mapped to.

country_iso2stringrequired

The ISO alpha-2 country code of the phone number.

document_idslist of stringsrequired

List of compliance documents mapped to this compliance application.

number_typestringrequired

Type of phone number. Allows values: local, national, toll free, mobile.

end_user_typestringrequired

Type of end user renting the phone number. Allowed values: individual, business.

Response

{
   "alias": "Address proof test New",
   "api_id": "27dd7750-e55a-11ec-bf06-0242ac110007",
   "created_at": "2022-06-06T05:33:12.075868Z",
   "document_id": "8db8118e-df4e-4bb7-b086-6bba10abe90a",
   "document_type_id": "eb356022-76bb-4950-90e2-293821ad4058",
   "end_user_id": "0124b993-681d-44f3-8229-776213a3c307",
   "file_name": "Screenshot 2022-05-25 at 5.03.43 PM.png",
   "message": "created",
   "meta_information": {
      "tax_code": "150"
   }
}

Example Request

1
1
1
1
1
1
1
1