Compliance Requirements
Compliance Requirements gives the list of information and documents required in order to activate a regulated phone number with Plivo. Compliance requirements may vary based on the following parameters:
- Country the phone number belongs to.
- Type of the phone number. Possible types are Local, National, Toll Free and Mobile
- End User Type. The type of the user who will receive the calls on this phone number. Possible values are Individual and Business.
Attributes
|
compliance_requirement_id |
Unique identifier for each Compliance requirement defined in Plivo’s system. |
|
country_iso string |
The Country of the phone number |
|
number_type string |
Type of Phone number. Possible values: local, National, toll free and mobile |
|
end_user_type string |
Type of end user renting the phone number. Possible values: individual and business |
|
acceptable_document_type |
List of document types required for regulatory compliance |
Response
Read Compliance Requirements
This API get Compliance requirements for a phone number
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceRequirements/
Arguments
country_iso string | A unique identifier for the hosted messaging order. |
number_type string | Type of Phone number. Possible values: Local,national,toll free and mobile |
end_user_type string | Type of end user renting the phone number. Possible values: individual and business |
Or
phone_number string | A unique identifier for the hosted messaging order. |
end_user_type string | Type of end user renting the phone number. Possible values: individual and business |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Compliance document type object
Regulatory compliance for each regulated phone number can require submission of one or more compliance documents, such as a passport, address information, or company-issued ID. To create a compliance document in Plivo, we need to first read the information required to create that document, which is derived from the compliance document type object.
document_type_id string | A unique identifier for the compliance document type. |
document_name string | Type of Phone number. Possible values: Local,national,toll free and mobile |
description string | Type of end user renting the phone number. Possible values: individual and business |
information string | A unique identifier for the hosted messaging order. |
proof_required string | Type of Phone number. Possible values: Local, National, Toll free and mobile |
created_at time stamp | Compliance Document Type creation time stamp. |
Response
Read all compliance document type information
This API gets compliance requirements for a phone number.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocumentType/
Arguments
| limit integer |
Denotes the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. |
| offset integer |
Denotes the number of value items by which the results should be offset. Defaults to 0. Read more about offset-based pagination. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Read specific compliance document type information
This API gets specific compliance requirements for a phone number.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocumentType/{ID}/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Compliance document type
A compliance document is a collection of information and associated proof that can be used across multiple compliance applications to activate multiple phone numbers.
To create a compliance document belonging to a particular compliance document type, we need to first get the list of fields and proofs required to create an instance of the required document type. For example, If we want to create a document of type “Passport,” we first need to get the list of fields and proofs required by querying the Passport compliance document type object.
Compliance Document Object
| document_type_idstring |
Unique identifier for each compliance document type. |
| aliasstring |
Friendly name for the created document. |
| end_user_idstring |
Unique identifier for the end user associated with this compliance document. |
| document_type_idstring |
Unique identifier of the compliance document type this document is an instance of. |
| Informationstring |
List of relevant information as defined by the compliance document type object. |
| prooffile |
Scanned proof supporting the provided information. |
| created_atTimestamp |
Compliance document creation time stamp. |
Response
Create compliance document
This API creates a new complaince document.
API Endpoint
POST https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocument/
Arguments
Arguments
| aliasstringrequired |
Friendly name for the document. |
| end_user_idstringrequired |
Unique identifier for the end user associated with this compliance document. |
| document_type_idstringrequired |
Unique identifier of the compliance document type this document is an instance of. |
| Informationstringrequired |
List of relevant information as defined by the compliance document type. |
| proof filerequired |
Scanned proof supporting the provided information. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
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"
}
}
Update an existing compliance document
This API updates compliance document fields.
API Endpoint
POST https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocument/{ID}/
Arguments
| aliasstring |
Friendly name for the document. |
| end_user_idstring |
Unique identifier for the end user associated with this compliance document. |
| document_type_idstringRequired |
Unique identifier of the compliance document type this document is an instance of. |
| Informationstring |
List of relevant information as defined by the compliance document type object. |
| proof file |
Scanned proof supporting the provided information. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}
Delete a compliance document
This API deletes a compliance document.
API Endpoint
DELETE https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocument/{ID}
Arguments
| aliasstring |
Friendly name for the document. |
| end_user_idstring |
Unique identifier for the end user associated with the compliance document. |
| document_type_idstringRequired |
Unique identifier of the compliance document type this document is an instance of. |
| Informationstring |
List of relevant information as defined by the compliance document type object. |
| proof file |
Scanned proof supporting the provided information. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}
Read all compliance documents
This API lets you fetch all of your compliance documents.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocument/{filters}
Arguments
| aliasstring |
Friendly name for a created document. |
| end_user_idstring |
Unique identifier for the end user associated with the compliance document. |
| document_type_idstringRequired |
Unique identifier of the compliance document type this document is an instance of. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Read specific compliance document information
This API retrieves details of a particular compliance document.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceDocument/{DocumentID}/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"alias": "Address proof test New1",
"api_id": "2eab3ea6-e572-11ec-98ea-0242ac110003",
"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",
"meta_information": {
"tax_code": "150"
}
}
End User object
End user objects help you manage compliance for different end users in your account. Every compliance document and compliance application in your account must be associated with a unique end user.
End User Object
| end_user_idstring |
Unique identifier for an end user in your account. |
| namestring |
Name of the end user. |
| last_namestring |
Last name of the end user. Optional for individual type users and not required for business type users. |
| end_user_typestring |
Type of end user. Allowed values: individual, business. |
| created_atdate |
Timestamp when the end user was created. |
Response
{
"api_id": "373d75a0-e574-11ec-8e0a-0242ac110003",
"created_at": "2022-06-06T05:14:44.290734Z",
"end_user_id": "0124b993-681d-44f3-8229-776213a3c307",
"end_user_type": "business",
"last_name": "User1",
"name": "Test-Business-ne"
}
Create an end user
This API creates an end user for the account.
API Endpoint
POST https://api.plivo.com/v1/Account/{auth_id}/EndUser/
Arguments
| namestringrequired |
Name of the end user. |
| last_namestring |
Last name of the end user. Optional for individual type users and not required for business type users. |
| end_user_typestringrequired |
Type of end user. 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"
}
}
Update an end user
API to update existing compliance document fields
API Endpoint
POST https://api.plivo.com/v1/Account/{auth_id}/EndUser/{ID}/
Arguments
| namestring |
Name of the end user. |
| last_namestring |
Last name of the end user. Optional for individual type users and not required for business type users. |
| end_user_typestring |
Type of end user. Allowed values: individual, business. |
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}
Delete an end user
This API deletes end user information.
API Endpoint
DELETE https://api.plivo.com/v1/Account/{auth_id}/EndUser/{ID}/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}
Read all end user information
This API gets all end user information.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/EndUser/
Arguments
| namestring |
Name of an end user. |
| last_namestring |
Last name of the end user. Optional for individual type users and not required for business type users |
| end_user_typestring |
Type of end user. Allowed values: individual, business. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Read specific end user information
This API gets end user information.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/EndUser/{End_userID}/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"alias": "Address proof test New1",
"api_id": "2eab3ea6-e572-11ec-98ea-0242ac110003",
"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",
"meta_information": {
"tax_code": "150"
}
}
Compliance Application
A compliance application is a way for users to submit all the required documents for a phone number as a single bundle. Once created, a compliance application needs to be submitted for review. Possible status of a compliance application during the review process can be:
- Draft: Prior to submitting, the compliance application remains in a draft state. At this point users may make updates to the application. Once all the information has been added and reviewed, the application can be submitted for a review.
- Submitted: At this point the information provided in the application is reviewed by Plivo. Updates to the information in the application are not allowed.
- Accepted: If the information provided in the application is in line with the regulatory requirement for the country, number type, and end user type, the compliance application is accepted.
- Rejected: If the information provided in the application does not meet the regulatory requirements, the application is rejected. Users can make corrections to the application and resubmit for a review.
Compliance Application Object
| compliance_application_idstring |
Unique identifier for each compliance application present in an account. |
| compliance_requirement_idstring |
Unique identifier for the compliance requirement this application is mapped to. |
| end_user_idstring |
Unique identifier for the end user this application is mapped to. |
| aliasstring |
Friendly name for the compliance application. |
| compliance_document_idstring |
List of compliance documents mapped to this compliance application. |
| statusfile |
Status of the compliance application. Allowed values: Draft, Submitted, Accepted, Rejected. |
| created_atdate |
Timestamp when the compliance application was created. |
| last_updated_atdate |
Timestamp when the compliance application was last updated. |
Response
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. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
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"
}
}
Update a compliance application
Update a compliance application.
API Endpoint
POST https://api.plivo.com/v1/Account/{auth_id}/ComplianceApplication/{ID}/
Arguments
| document_idsList of string IDs |
List of compliance documents mapped to this compliance application. |
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}
Delete an existing compliance application
API to delete a compliance document.
API Endpoint
DELETE https://api.plivo.com/v1/Account/{auth_id}/ComplianceApplication/{ID}/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}
Read compliance application information
Get compliance application details.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceApplication/
Arguments
| aliasstring |
Friendly name for a created compliance application. |
| end_user_idstring |
Unique identifier for the end user this application is mapped to. |
| country_iso2string |
The ISO alpha-2 country code of the phone number. |
| number_typestring |
Type of phone number. Allowed values: local, national, toll free, mobile. |
| end_user_typestring |
Type of end user renting the phone number. Allowed values: individual business. |
| statusstring |
Status of the compliance application. Allowed values: Draft, Submitted, Accepted, Rejected. |
Read specific compliance application information
Get compliance application information.
API Endpoint
GET https://api.plivo.com/v1/Account/{auth_id}/ComplianceApplication/{ID}/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"alias": "Address proof test New1",
"api_id": "2eab3ea6-e572-11ec-98ea-0242ac110003",
"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",
"meta_information": {
"tax_code": "150"
}
}
Submit a compliance application
Submit a compliance application for review.
API Endpoint
POST https://api.plivo.com/v1/Account/{auth_id}/ComplianceApplication/{ApplicationID}/Submit/
Arguments
Example Request
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
1
Was this code helpful
Response
{
"api_id": "a75ab7a6-e571-11ec-8e0a-0242ac110003",
"message": "changed"
}