Documents
Use these methods to manage documents submitted by the current client for passing a verification procedure.
GET[host]/api/v2/my/documents |
|
GET[host]/v2/my/documents/{documentId} |
|
POST[host]/v2/my/documents |
|
DELETE[host]/v2/my/documents/{documentId} |
Get a list of documents
Use this method to obtain a list of documents (such as an ID card, passport or driver’s license) submitted by the current client for passing a verification procedure.
To obtain detailed information about a specific document, use a separate method to get document details.
Request
Header parameters:
accept-language: <string>
Accept: application/json
Authorization: Bearer <access_token>
GET[host]/api/v2/my/documents
curl --location --request GET 'https://host.name/api/v2/my/documents?limit=10&offset=0' \
--header 'accept-language: ja' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'
Response
A response contains an array of Document objects providing information about the available documents.
Get document details
Use this method to obtain detailed information about a specified document submitted by the current client for passing a verification procedure.
To obtain a list of all documents submitted by the current client, use a separate method to get a list of documents.
Request
Header parameters:
accept-language: <string>
Accept: application/json
Authorization: Bearer <access_token>
Path parameters:
- documentId required
The identifier of a document.
GET[host]/v2/my/document/{documentId}
curl --location --request GET 'https://host.name/api/v2/my/documents/1' \
--header 'accept-language: ja' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'
Response
A response contains a Document object providing information about the specified document.
Add a new document
Use this method to add a new document required for passing a verification procedure by the current client.
Request
Header parameters:
accept-language: <string>
Accept: application/json
Content-Type: application/json
Authorization: Bearer <access_token>
Body:
Specify the following parameters for a document:
- file string required
The path to a document file.
- typeID integer required
The identifier of a document type with which a document is associated.
POST[host]/api/v2/my/documents
curl --location --request POST 'https://host.name/api/v2/my/documents' \
--header 'accept-language: ja' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"file": "officia dolore exercitation p",
"typeId": 1
}'
Response
A response includes a Document object providing information about the added document.
Delete a document
Use this method to delete a specified document that was previously submitted by the current client for passing a verification procedure.
Request
Header parameters:
Accept: application/json
Authorization: Bearer <access_token>
Path parameters:
- documentId required
The identifier of a document.
DELETE[host]/api/v2/my/documents/{documentId}
curl --location --request DELETE 'https://host.name/api/v2/my/documents/1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'
Response
In case of success, no response body is returned.