> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rolla.xyz/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Verification Documents
> Returns the identity document an individual account holder submitted during Rolla's hosted liveness check, plus the details read off that document. For a business account's beneficial owners, use the related-person endpoint.
Returns the identity document your customer submitted during Rolla's hosted liveness check, along with the details read off that document by the identity provider.
Use it to review what was submitted without running a second identity check of your own. For a business account's beneficial owners and directors, use [Get Owner Verification Documents](/api-reference/endpoint/accounts/related-person-verification-documents) instead.
## Example Request
```bash theme={null}
curl -X GET "https://api.rolla.xyz/api/v1/external/accounts/b6075be0-f1d0-451f-a468-3e94563101d2/verification/documents" \
-H "X-API-Key: your_api_key_here"
```
## Example Response
```json theme={null}
{
"success": true,
"message": "Verification documents retrieved successfully",
"data": {
"subject": {
"type": "account",
"id": "b6075be0-f1d0-451f-a468-3e94563101d2"
},
"status": {
"reviewStatus": "completed",
"reviewAnswer": "GREEN",
"verified": true
},
"identity": {
"firstName": "Jane",
"lastName": "Doe",
"dateOfBirth": "1990-01-15",
"country": "NGA",
"idDocType": "PASSPORT",
"documentNumber": null,
"issuedDate": null,
"validUntil": null
},
"documents": [
{
"imageId": "909788538",
"idDocType": "PASSPORT",
"country": "NGA",
"side": "front"
}
],
"inspectionId": "6a7ba5bcce15d46609bd3f4b"
}
}
```
## Response Fields
| Field | Type | Description |
| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
| `subject.type` | string | `account` here; `related_person` on the owner endpoint |
| `status.verified` | boolean | `true` once the review completed with a positive result |
| `status.reviewStatus` | string | Review state, e.g. `init`, `pending`, `completed` |
| `status.reviewAnswer` | string | `GREEN` (passed) or `RED` (failed); `null` while in progress |
| `identity` | object | Read **off the document** by the identity provider — not the values you submitted |
| `identity.idDocType` | string | e.g. `PASSPORT`, `ID_CARD`, `DRIVERS` |
| `documents[].imageId` | string | Pass to [Download Verification Document](/api-reference/endpoint/accounts/download-verification-document) to fetch the file |
| `documents[].side` | string | `front` or `back` |
| `inspectionId` | string | The provider's inspection reference, for support queries |
`identity` reflects what the provider could extract. `documentNumber`, `issuedDate` and `validUntil` are frequently `null` even on a passed check — treat every field as optional rather than relying on it being present.
Selfies and liveness frames are not returned; only identity documents are.
## Error Responses
### Verification not started (`404`)
```json theme={null}
{
"status": 404,
"message": "No verification found. The identity check has not been started or completed yet."
}
```
### Wrong account type (`400`)
```json theme={null}
{
"status": 400,
"message": "This endpoint is only for individual accounts. Use /related-persons/:personId/verification/documents for business owners and directors."
}
```
## OpenAPI
````yaml GET /accounts/{accountId}/verification/documents
openapi: 3.1.0
info:
title: Rolla Developer API
description: >-
API for programmatic transaction management on the Rolla platform. Monetary
`amount` fields use the smallest unit of the referenced currency unless an
endpoint says otherwise (e.g. NGN = kobo, USD = cents, where **100 cents =
USD 1.00**).
version: 1.0.0
servers:
- url: https://api.rolla.xyz/api/v1/external
description: Production server
security:
- apiKeyAuth: []
paths:
/accounts/{accountId}/verification/documents:
get:
summary: Get Verification Documents
description: >-
Returns the identity document an individual account holder submitted
during Rolla's hosted liveness check, plus the details read off that
document. For a business account's beneficial owners, use the
related-person endpoint.
operationId: getAccountVerificationDocuments
parameters:
- name: accountId
in: path
required: true
description: >-
Identifier of an account owned by the same user as your API key's
business
schema:
type: string
format: uuid
responses:
'200':
description: Verification documents retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Verification documents retrieved successfully
data:
type: object
properties:
subject:
type: object
description: Who the verification belongs to
properties:
type:
type: string
enum:
- account
- related_person
example: account
id:
type: string
format: uuid
status:
type: object
properties:
verified:
type: boolean
example: true
description: >-
True once the review completed with a positive
result
reviewStatus:
type: string
nullable: true
example: completed
reviewAnswer:
type: string
nullable: true
example: GREEN
description: >-
GREEN (passed) or RED (failed); null while in
progress
identity:
type: object
description: >-
Read off the document by the identity provider, not
the values you submitted. Every field is best-effort
and may be null even on a passed check.
properties:
firstName:
type: string
nullable: true
example: Jane
lastName:
type: string
nullable: true
example: Doe
dateOfBirth:
type: string
nullable: true
example: '1990-01-15'
country:
type: string
nullable: true
example: NGA
idDocType:
type: string
nullable: true
example: PASSPORT
documentNumber:
type: string
nullable: true
description: >-
Frequently null — the provider does not always
extract it
issuedDate:
type: string
nullable: true
validUntil:
type: string
nullable: true
documents:
type: array
description: >-
Identity documents submitted during the liveness
check. Selfies are not returned.
items:
type: object
properties:
imageId:
type: string
example: '909788538'
description: Pass to the download endpoint to fetch the file
idDocType:
type: string
example: PASSPORT
country:
type: string
nullable: true
example: NGA
side:
type: string
enum:
- front
- back
example: front
inspectionId:
type: string
nullable: true
example: 6a7ba5bcce15d46609bd3f4b
description: >-
The provider's inspection reference, for support
queries
'400':
description: Wrong account type for this endpoint
content:
application/json:
schema:
type: object
properties:
status:
type: integer
example: 400
message:
type: string
example: >-
This endpoint is only for individual accounts. Use
/related-persons/:personId/verification/documents for
business owners and directors.
'404':
description: Verification has not been started or completed
content:
application/json:
schema:
type: object
properties:
status:
type: integer
example: 404
message:
type: string
example: >-
No verification found. The identity check has not been
started or completed yet.
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: Your Rolla API key
````