GET
/api/conversations/{conversationId}Retrieving up-to-date data as defined by the user identity verification process
In practice, instead of this method you should use the callback mechanism described here(opens in new tab).
Returns information about how the identity validation process is performed for the given conversation ID. In the case of using the callback mechanism, the use of this method is optional - data needed are sent automatically when they change.
Detailed Description of the Reply Contents
| Parameter | Example | Description |
|---|---|---|
| id | e0c0b3cc-8238-414f-9940-9f14bd1b8693 | Conversation ID. |
| userKey | 7dfb9ded-c38f-49ae-95e2-307283a0b1f6 | User ID on your system. |
| url | https://sandbox.authologic.com/c/c12c1adc-3ff0-4d32-b95c-c593135c903e | A unique web address to which the user should be redirected to verify his identity. |
| status | FINISHED | Conversation status: CREATED - ready conversation, IN_PROGRESS - query data being specified, FINISHED - query is complete, CANCELED - user aborted, EXPIRED - conversation expired |
| result | - | Structure describing the information found |
| result.identity | - | Structure describing the result of the identity check |
| result.identity.status | Identity validation effect: IN_PROGRESS - checks in progress, FINISHED - checks from query complete, PARTIAL - checks completed but only part of the data could be determined, FAILED - checks completed but no data could be determined. | |
| result.identity.user | (see example in verify.user from /api/conversations) | User information |
| result.identity.errors | ["SCAN_DOCUMENT_NOT_DETECTED"] | Information about the causes of errors. The content depends on the specific method of verification |
| result.identity.checks | - | A list of additional validations performed on user data |
| result.aml | - | Structure describing the result of user checking on AML lists |
| result.aml.status | User checking effect. Same as the result.identity.status field | |
| result.aml.found | ["PEP", "SANCTIONS", "ADVERSE_MEDIA", "SIP", "OTHER"] | A table informing about the AML lists on which user data was found. |
| result.aml.subscription | - | Structure that informs that the AMLs to be checked are periodic |
| result.aml.subscription.active | true | Structure that informs about active periodic AML checking |
| result.aml.subscription.lastChanged | "2020-09-17T11:18:21.999Z" | Date when the user's information on the AMLs was last changed |
| result.verify | - | Structure describing the result of comparing the data obtained from the identity verification process |
| result.verify.status | Identity validation effect: IN_PROGRESS - checks in progress, FINISHED - checks from query complete, PARTIAL - checks completed but only part of the data could be determined, FAILED - checks completed but no data could be determined. | |
| result.verify.reliability | 0.66667 | A number specifying the similarity of the data obtained from the identity check process to the data provided in the query, where 0 means different data and 1.0 means identical data. Due to the differences in the format, data recording the value can be any value between 0 and 1. |
| result.verify.details | - | Details of the individual data comparison storing the name of the field being compared and a number indicating the similarity of the data. |
| result.auth | - | Structure describing the result of user authentication |
| result.auth.status | Authentication status: IN_PROGRESS - checks in progress, FINISHED - checks from query complete, FAILED - checks completed but no data could be determined. | |
| result.auth.token | a7d5d522-5308-4ec9-9789-53b4ec6d47ae | A unique user ID associated with a given login method. Going through the login process again with the given method will always return the same token. |
| result.auth.challenge | 403ad98c-c5fd-4991-a365-12ec70a93932 | A unique equivalent of the user login associated with a given login method. Used in methods that cannot determine who is authenticating and need this information to run the process. |
| result.bankTransactions | - | Structure describing the result of downloading transactions |
| result.bankTransactions.status | Effect of downloading transactions. Same as the result.identity.status | |
| result.affordability | - | Structure describing the result of the identity check |
| result.affordability.status | Affordability assessment validation effect: IN_PROGRESS - checks in progress, FINISHED - checks from query complete, FAILED - checks completed but no data could be determined. | |
| result.affordability.errors | ["PROVIDER_UNAVAILABLE"] | Information about the causes of errors. |
| result.databaseVerification | - | Structure describing the result of the database verification check |
| result.databaseVerification.status | Database verification effect: IN_PROGRESS - checks in progress, FINISHED - checks from query complete, PARTIAL - checks completed but only part of the data could be determined, FAILED - the checks have been completed, but none of the databases were successfully verified. | |
| info | - | Optional information containing an array describing the data sources used in the conversation. |
| info.country | PL | Selected/used country in ISO 3166-1 alpha-2 format |
| method | PSD2 | Data source used specifying the verification method or data source used. |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversationId | path | string | Required | Conversation ID |
Responses
Conversation found
Content-Type
application/vnd.authologic.v1.1+jsonJSONidstring required Unique identifier for the conversation
Example:
e0c0b3cc-8238-414f-9940-9f14bd1b8693userKeystring required Unique user identifier in the Customer's system
Example:
d5dbb8e0-192e-4bc6-972c-f7948409d10curlstring required The address where user should be redirected to perform the verification
Example:
https://sandbox.authologic.com/c/022e8eaf-b06d-44b9-a68f-45eef1353dbestatusstring required Conversation state
- CREATED - conversation ready to be run
- IN_PROGRESS - data is being determined from the query
- FINISHED - query checks have been completed
- CANCELED - checking interrupted by the user
- EXPIRED - conversation is expired
Allowed values:
CREATEDIN_PROGRESSFINISHEDCANCELEDEXPIREDresultConversationInfoResult required The result of checking individual elements
infoarray<ConversationStrategyInfo>The information about activated strategy elements
Bad Request
Content-Type
application/vnd.authologic.v1.1+jsonJSONOne of:
Variant 1
BadRequestApiError Variant 2
MethodArgumentNotValidError Variant 3
MethodArgumentTypeMismatchError Variant 4
ConstraintViolationError Variant 5
CustomValidationApiError Variant 6
OperationNotSupportedApiFieldError Variant 7
MissingHeaderApiErrorExhaustion of the plan or limitations related to non-payment
Forbidden
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Conversation not found
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Conversation is unavailable
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Server side error