/api/conversations/{conversationId}/identity/metadataRetrieving information about the metadata collected during the identification process
Returns information about the available metadata that was collected during the identification process.
Detailed description of returned fields:
| Parameter | Example | Description |
|---|---|---|
| id | 9db8a804-4570-403e-9da6-162e608585e8 | Conversation ID. |
| letter | - | A structure representing the set of metadata collected from the identity validation process. |
| list.media | - | List of information about available multimedia files. |
| list.media.id | 7a4d1a9f-bdac-4d2c-96a6-bb51fb4ec7c5 | The ID of the media file. |
| list.media.type | DOCUMENT | Media file type. Possible values: DOCUMENT - document of the authenticated person, FACE - face of the authenticated person, REPORT - report on the verification process |
| list.media.subtype | ID_CARD | The sub-type of the media file, such as the type of document. The value is blank if type = FACE. ID_CARD - identity card of the authenticated person, DRIVER_LICENSE - driving license of the authenticated person, PASSPORT - passport of the authenticated person, RESIDENCE_PERMIT - residence card of the authenticated person, UTILITY_BILL - proof of address of the authenticated person |
| list.media.variant | FRONT | Variant of the media file, e.g. document page. The value is blank if type = FACE. FRONT - front side of the document, BACK - back side of the document |
| list.media.contentType | image / png | The type of media file content. Example values: image/png, video/mp4 |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversationId | path | string | Required | Conversation ID |
Responses
Information available
application/vnd.authologic.v1.1+jsonidstring required Conversation Id
listobject required Metadata list, collected during the identification process
mediaarray<object> required List of available media files
Bad Request
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
statusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Exhaustion of the plan or limitations related to non-payment
Permission denied
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Conversation not found
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Conversation is unavailable
application/vnd.authologic.v1.1+jsonstatusstring required Response status
messagestring required Descriptive error message
violationsarray<object> required Validation error list
Validation error list
fieldstring required Field name
messagestring required Descriptive error message
statusDetailstring optional Response status detailed information
Server side error