GetAccountDocuments

View as Markdown
Gets the account documents and the verification states. This method will be deprecated in the next versions. We recommend to use the [GetAccountVerifications](/api-reference/management-api/accounts/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](/api-reference/management-api/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 objects
The account documents with verification states