GetAccountDocuments

POST

https://api.voximplant.com/platform_api/GetAccountDocuments

POST

/platform_api/GetAccountDocuments

curl -X POST https://api.voximplant.com/platform_api/GetAccountDocuments \
     -H "Authorization: Bearer <token>"

200Example 1

{
  "result": [
    {
      "account_id": 1,
      "verifications": [
        {
          "verification_name": "RU",
          "verification_status": "IN_PROGRESS",
          "unverified_hold_until": "2015-02-15",
          "documents": [
            {
              "account_document_id": 66,
              "is_individual": true,
              "comment": "very low quality",
              "uploaded": "2015-02-01 06:50:07",
              "account_document_status": "REJECTED"
            },
            {
              "account_document_id": 74,
              "is_individual": true,
              "uploaded": "2015-02-01 07:34:01",
              "account_document_status": "IN_PROGRESS"
            }
          ]
        }
      ]
    }
  ]
}

Gets the account documents and the verification states.

This method will be deprecated in the next versions. We recommend to use the GetAccountVerifications method to get all the verifications and statuses for the account.

Allowed roles: Owner, Admin, Accountant, Payer.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

with_detailsbooleanOptionalDefaults to false

Whether to view the uploaded document statuses. (The flag is ignored with the child_account_id=all)

verification_namestringOptional

The required account verification name to filter

verification_statuslist of stringsOptional

The account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED

from_unverified_hold_untilstringOptional

Unverified subscriptions hold until the date (from ...) in the following format: YYYY-MM-DD

to_unverified_hold_untilstringOptional

Unverified subscriptions hold until the date (... to) in the following format: YYYY-MM-DD

child_account_idlist of integersOptional

The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts

children_verifications_onlybooleanOptionalDefaults to false

Whether to get the children account verifications only

Response

Successful response

resultlist of objectsOptional

The account documents with verification states