{ "openapi": "3.1.0", "info": { "title": "Authologic Customer API", "description": "\nThe integration API for using with Authlogic Engine.\n\nAuthologic allows for simple and effective checking of the user's identity, and the use of API enables initiation by an external system\nthe verification process and the receipt of its results.\n ", "contact": { "name": "API support", "email": "tech-support@authologic.com" }, "version": "1.1" }, "externalDocs": { "description": "API Documentation", "url": "https://developer.authologic.com" }, "servers": [ { "url": "https://sandbox.authologic.com", "description": "Testing environment" } ], "security": [ { "apiKey": [] }, { "oauth2": [] } ], "tags": [ { "name": "Conversation", "description": "1. Base Methods needed for the verification process.", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/home" } }, { "name": "Bank", "description": "2. Product: Bank Transactions", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/product-bank-transactions-index" } }, { "name": "AML", "description": "3. Product: AML", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/product-aml-index" } }, { "name": "Advanced", "description": "4. Advanced methods.", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/home" } }, { "name": "Metadata", "description": "5. Advanced: Metadata", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/additional-information-metadata" } }, { "name": "Enterprise Integration", "description": "6. Enterprise Integration", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/additional-headless-integration" } }, { "name": "Affordability assessment", "description": "7. Product: Affordability assessment", "externalDocs": { "description": "Usage", "url": "https://developer.authologic.com/docs/developer-documentation/product-affordability-index" } } ], "paths": { "/api/conversations": { "post": { "tags": ["Conversation"], "summary": "Start a new user verification process", "description": "\nEach process of getting data and confirming the identity of the user should start by calling this method.\nThe call initiates this process and returns information about the address to which the user should be redirected to\ngathering the information requested from him.\n\n::note\nIn order to use the API you need to obtain the login and password for a for a specific environment. \nYou can generate a new API key in the API Keys section of the OmniPanel.\nThe API is accessible via either HTTP Basic authentication or OAuth2 client credentials flow.\nBoth methods accept the same API key. \nWhen using OAuth2, the API key can be sent either via Authentication Bearer header or via HTTP POST body. \n::\n\n\n::note\nThis is because all of these fields may have their default values set on the Authologic side when creating your account. If any value does not have a default setting you will get an error and you should either provide that value or report to Authologic to set the default one.\n::\n\nThe query contains three groups of information:\n * general information such as:\n * **userKey**: User ID on your system\n * **strategy**: information about the identity checking strategy (usually the default value is sufficient)\n * **returnUrl**: URL to which the user should be redirected after the process is completed\n * **callbackUrl**: information about the return address to which the system will send the acquired information. If this information is not provided, Authologic assumes that the information will be downloaded by the client\n * **query**: query definition containing individual products provided by Authologic\n\n::warning\nThe test environment allows the use of an HTTP address for **callbackUrl**. A production environment always requires HTTPS.\n::\n\n::note\nFor testing purposes, to check the callback request, you can use online tools that accept and present the outgoing requests. One such tool is, for example, [Webhook](https://webhook.site/). When creating a conversation, it is enough to provide the url generated by Webhook in the callbackUrl parameter.\n::\n\n\nThe information contained in the query section is divided into specific products:\n * **identity** - fetch user information. This section is always required\n * **requireOneOf**: User information to be specified by Authologic. This is represented as set of sets and Authologic will try to fetch one of these\n * **optional**: User information that may be specified by Authologic when the information is available\n * **aml** - check user on AML lists\n * **checks**: lists where the user should be checked\n * **auth** - user authentication product\n * **bankTransactions** - the process of retrieving information about transactions.\n * **type**: type of transaction - credit, debit or all\n * **flags**: Additional information on what to return\n * **verify** - confirmation of the compliance of user data\n * **user**: information about user that should be verified\n ", "operationId": "createConversation", "requestBody": { "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/CreateConversation" }, "examples": { "Simple verification process example": { "summary": "The simplest verification process", "description": "This example shows the main scenario of verification.", "value": { "userKey": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "returnUrl": "https://authologic.com/tests/return/?conversation={conversationId}", "strategy": "public:default", "query": { "identity": { "requireOneOf": [["PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME"]], "optional": [ { "list": ["PERSON_CONTACT_EMAIL_OTP"] } ] } } } }, "Multiple success options example": { "summary": "The process with multiple success options", "description": "This example shows how to use multiple field sets to describe alternative success options.", "value": { "userKey": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "returnUrl": "https://authologic.com/tests/return/?conversation={conversationId}", "strategy": "public:default", "query": { "identity": { "requireOneOf": [ [ "PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME", "PERSON_IDS_NATIONAL_ID" ], [ "PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME", "PERSON_IDS_PASSPORT_ID" ] ], "optional": [ { "list": ["PERSON_CONTACT_EMAIL_OTP"] } ] } } } }, "AML verification process example": { "summary": "Verification process with AML continuous monitoring", "description": "This example shows how to perform verification and set up the AML monitoring.", "value": { "userKey": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "returnUrl": "https://authologic.com/tests/return/?conversation={conversationId}", "strategy": "public:default", "query": { "identity": { "requireOneOf": [["PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME"]] }, "aml": { "checks": ["PEP", "SANCTIONS"], "subscription": {} } } } }, "Example usage of the authorization product": { "summary": "The user authorization product", "description": "This example shows the main scenario for user authorization.", "value": { "userKey": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "returnUrl": "https://authologic.com/tests/return/?conversation={conversationId}", "strategy": "public:default", "query": { "auth": {} } } }, "Example usage of the affordability product": { "summary": "The affordability product", "description": "This example shows the main scenario of verification.", "value": { "userKey": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "returnUrl": "https://authologic.com/tests/return/?conversation={conversationId}", "strategy": "public:default", "query": { "affordability": { "user": { "country": "NL", "email": "test.user@email.com" } } } } } } } } }, "responses": { "200": { "description": "Conversation started", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ConversationInfo" }, "examples": { "Conversation created response example": { "summary": "Conversation Created and waiting for the user", "description": "The conversation was created and now the user should be redirected to the given url.", "value": { "id": "022e8eaf-b06d-44b9-a68f-45eef1353dbe", "userKey": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "url": "https://sandbox.authologic.com/c/022e8eaf-b06d-44b9-a68f-45eef1353dbe", "status": "CREATED", "result": { "identity": { "status": "IN_PROGRESS", "user": {} } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "examples": { "Bad request example": { "summary": "Bad request example", "description": "Example of bad request in case validation error.", "value": { "status": "BAD_REQUEST", "message": "Validation failed for argument example_argument", "violations": [] } } } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "examples": { "Forbidden call response example": { "summary": "Forbidden example", "description": "Example of forbidden call.", "value": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/headless/{next}": { "post": { "tags": ["Enterprise Integration"], "summary": "Send the information obtained from the user during the identity verification process", "description": "\nTakes the information from the user and calculates the next step that should be rendered to the user.\n\nDetailed description of returned attributes:\n\n| Parameter | Example | Description |\n| --------- | ------- | ----------- |\n| component | GLOBAL/ACCEPTED | Name of method related with current step and expected action related to UI in verification process. |\n| next | fd78cf43-12a7... | Id of the page to which the user information should be submitted. Information is sent via the method `POST /api/conversations/{conversationId}/headless/{next}`. |\n| args | parameter name list | List of parameters that should be displayed to the user. |\n| errors | map with field name and error description | A map specifying incorrectly entered form fields and a description of the associated error. |\n| errors.field | parameter name sent in `body` attribute, validated and marked as incorrect | Value specifying incorrectly entered form field. |\n| errors.code | error code related to the field described in `errors.field` attribute | Value describing the error associated to the form field. |\n", "operationId": "nextStep", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "path", "description": "Next step ID", "required": true, "schema": { "type": "string" } }, { "name": "X-User-IP", "in": "header", "description": "User IP Address", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadlessNextPageRequest" } } }, "required": true }, "responses": { "200": { "description": "Information available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/HeadlessPage" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Permission denied", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:global`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}": { "get": { "tags": ["Conversation"], "summary": "Retrieving up-to-date data as defined by the user identity verification process", "description": "\n::warning\nIn practice, instead of this method you should use the callback mechanism described here.\n::\n\nReturns information about how the identity validation process is performed for the given conversation ID.\nIn the case of using the callback mechanism, the use of this method is optional - data needed\nare sent automatically when they change.\n\n## Detailed Description of the Reply Contents\n\n| Parameter | Example | Description |\n|-----------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| id | e0c0b3cc-8238-414f-9940-9f14bd1b8693 | Conversation ID. |\n| userKey | 7dfb9ded-c38f-49ae-95e2-307283a0b1f6 | User ID on your system. |\n| 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. |\n| status | FINISHED | Conversation status: `CREATED` - ready conversation, `IN_PROGRESS` - query data being specified, `FINISHED` - query is complete, `CANCELED` - user aborted, `EXPIRED` - conversation expired |\n| result | - | Structure describing the information found |\n| result.identity | - | Structure describing the result of the identity check |\n| 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. |\n| result.identity.user | (see example in `verify.user` from `/api/conversations`) | User information |\n| result.identity.errors | [\"SCAN_DOCUMENT_NOT_DETECTED\"] | Information about the causes of errors. The content depends on the specific method of verification |\n| result.identity.checks | (see examples in [additional validations documentation](../addon-checks.md).) | A list of additional validations performed on user data |\n| result.aml | - | Structure describing the result of user checking on AML lists |\n| result.aml.status | | User checking effect. Same as the `result.identity.status` field |\n| result.aml.found | [\"PEP\", \"SANCTIONS\", \"ADVERSE_MEDIA\", \"SIP\", \"OTHER\"] | A table informing about the AML lists on which user data was found. |\n| result.aml.subscription | - | Structure that informs that the AMLs to be checked are periodic |\n| result.aml.subscription.active | true | Structure that informs about active periodic AML checking |\n| result.aml.subscription.lastChanged | \"2020-09-17T11:18:21.999Z\" | Date when the user's information on the AMLs was last changed |\n| result.verify | - | Structure describing the result of comparing the data obtained from the identity verification process |\n| 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. |\n| 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. |\n| 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. |\n| result.auth | - | Structure describing the result of user authentication |\n| result.auth.status | | Authentication status: `IN_PROGRESS` - checks in progress, `FINISHED` - checks from query complete, `FAILED` - checks completed but no data could be determined. |\n| 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. |\n| 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. |\n| result.bankTransactions | - | Structure describing the result of downloading transactions |\n| result.bankTransactions.status | | Effect of downloading transactions. Same as the `result.identity.status` |\n| result.affordability | - | Structure describing the result of the identity check |\n| 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. |\n| result.affordability.errors | [\"PROVIDER_UNAVAILABLE\"] | Information about the causes of errors. |\n| info | - | Optional information containing an array describing the data sources used in the conversation. |\n| info.country | PL | Selected/used country in ISO 3166-1 alpha-2 format |\n| method | PSD2 | Data source used specifying the verification method or data source used. |\n\n ", "operationId": "getConversation", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conversation found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ConversationInfo" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } }, "delete": { "tags": ["Advanced"], "summary": "Block access or delete data of the verification process", "description": "\nCreates the conversation deletion order in two available modes:\n * EXPIRE (default) - triggers the process of expiration of active conversation. \n After completing such an order, the conversation will be switched to the 'EXPIRED' status.\n The verification process will be blocked. \n This means that the user entering such a verification process will be automatically redirected to the 'returnUrl' address.\n * DELETE_DATA - triggers the process of data deletion from finished conversation. \n This mode should be used with caution, when you are sure that you do not expect any callbacks associated with the conversation \n as they may not be delivered.\n ", "operationId": "deleteConversation", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Deletion mode", "required": false, "schema": { "type": "string", "enum": ["EXPIRE", "DELETE_DATA"] } } ], "responses": { "202": { "description": "Accepted" }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "409": { "description": "Conflict", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "examples": { "Conversation cannot be expired as it is already finished.": { "description": "Conversation cannot be expired as it is already finished.", "value": { "status": "CONFLICT", "message": "Conversation cannot be expired as it is already finished.", "violations": [], "statusDetail": "ConversationAlreadyFinished" } }, "Conversation cannot be deleted because it is not yet finished.": { "description": "Conversation cannot be deleted because it is not yet finished.", "value": { "status": "CONFLICT", "message": "Conversation cannot be deleted because it is not yet finished.", "violations": [], "statusDetail": "ConversationNotYetFinished" } }, "Conversation cannot be deleted because it has an active subscription.": { "description": "Conversation cannot be deleted because it has an active subscription.", "value": { "status": "CONFLICT", "message": "Conversation cannot be deleted because it has an active subscription.", "violations": [], "statusDetail": "ActiveSubscriptionExists" } } } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/identity/metadata": { "get": { "tags": ["Metadata"], "summary": "Retrieving information about the metadata collected during the identification process", "description": "\nReturns information about the available metadata that was collected during the identification process.\n\nDetailed description of returned fields:\n\n| Parameter | Example | Description |\n| --------- | ------- | ----------- |\n| id | 9db8a804-4570-403e-9da6-162e608585e8 | Conversation ID. |\n| letter | - | A structure representing the set of metadata collected from the identity validation process. |\n| list.media | - | List of information about available multimedia files. |\n| list.media.id | 7a4d1a9f-bdac-4d2c-96a6-bb51fb4ec7c5 | The ID of the media file. |\n| 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 |\n| 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 |\n| 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 |\n| list.media.contentType | image / png | The type of media file content. Example values: `image/png`, `video/mp4` |\n ", "operationId": "getMetadata", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Information available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/IdentityMetadata" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Permission denied", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/identity/metadata/media/{id}": { "get": { "tags": ["Metadata"], "summary": "Retrieving media file that was collected during the identification process", "description": "\nReturns stream of media file (images, videos, pdf reports etc.) collected during identification process.\n\nIf the answer is successful, the data stream will be provided along with the following key HTTP headers:\n\n| Header | Example | Description |\n| ------ | ------- | ----------- |\n| content-disposition | attachment; filename = 9db8a804-4570-403e-9da6-162e608585e8_idi_ID_CARD_BACK.png | The file name is generated based on information about the media file. |\n| content-type | image / png | The type of multimedia file content, similar to the one presented in the information about the given file. |\n| status | 200 | Response status. |\n\nIn case of a wrong answer, the error information will be passed in the format `application/vnd.authologic.v1.1+json`.\n ", "operationId": "getMedia", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Media ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Information available", "content": { "application/octet-stream": {} } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Permission denied", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/headless": { "get": { "tags": ["Enterprise Integration"], "summary": "Obtaining the information needed to show the user the current page of the identity verification process", "description": "\nReturns information about the values that should be rendered on page and displayed to the user.\n\nDetailed description of the returned attributes:\n\n| Parameter | Example | Description |\n| --------- | ------- | ----------- |\n| component | SMART_ID/SHOW_CODE | Name of method related with current step and expected action related to UI in verification process. |\n| next | fd78cf43-12a7... | Id of the page to which the user information should be submitted. Information is sent via the method `POST /api/conversations/{conversationId}/headless/{next}`. |\n| args | parameter name list | List of parameters that should be displayed to the user. |\n", "operationId": "currentStep", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "X-User-IP", "in": "header", "description": "User IP Address", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Information available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/HeadlessPage" } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Permission denied", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:global`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/bankTransactions": { "get": { "tags": ["Bank"], "summary": "Retrieving a list of banking transactions related to the conversation", "description": "\nThe method allows you to get user transactions, if the conversation contains them. By default, it downloads transactions for a maximum of 90 full days,\nthat is: today + 90 previous days. If you need a larger scope - please contact us. Transactions are returned as defined when creating the conversation.\nBy default, this means both crediting and debiting the account, and only transactions that have already been made (posted or pending).\nTransactions are available when the appropriate callback is received, or when the _bankTransactions_ status reaches _FINISHED_.\n\n## Query Parameters Description\nThe method supports the following query parameters:\n\n| Parameter | Example | Description |\n| ------- | ------- | ------- |\n| page | 10 | Page number. Paging starts on page 0 (default). |\n| pageSize | 10 | Number of transactions on the results page. Currently, values above 200 are treated as 200. |\n\n## Response Content\n\nDetailed description of returned fields:\n\n| Parameter | Example | Description |\n|---------------------------------------| ------- | ----------- |\n| id | 34df2bd6-b790-4560-9fc9-f86c86d87990 | Unique transaction identifier |\n| date | 2020-08-27T10: 40: 28.348Z | Date of operation in UTC time |\n| status | PENDING | Status of a given transaction at the time of downloading information from the bank. Allowed values: `BOOKED` - posted transaction, `PENDING` - transaction in progress, `SCHEDULED` - future transaction. Scheduled transactions appear when the `flags` field with the value` INCLUDE_SCHEDULED` was specified when creating the conversation. |\n| bank | BREXPLPW | Bank where the transaction was performed. The value identifies the bank as the SWIFT / BIC code. |\n| accountId | PL68249000050000400075212326 | Account number where transaction was registered. |\n| type | DEBIT | Type of transaction. Available values: `DEBIT` (account debit) and `CREDIT` (account credit) |\n| amount | 1000 | Value of the transaction in a currency unit, e.g. in grosze. |\n| currency | PLN | type of currency |\n| title | Account top-up | Transaction title |\n| sender | Jan Kowalski | Transaction sender |\n| senderAccountId | PL68249000050000400075212326 | Account number of the sender |\n| recipient | Jan Kowalski | Recipient of the transaction |\n| recipientAccountId | PL32114020040000320250132522 | Account number of the receiver |\n| tags | [\"transfer:bank:commission\", \"income:crypto\"] | Transaction categories |\n ", "operationId": "getBankTransactions", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0 } }, { "name": "pageSize", "in": "query", "description": "The number of items on the page", "required": false, "schema": { "type": "integer", "format": "int32", "maximum": 200, "minimum": 0 } } ], "responses": { "200": { "description": "Transaction list available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/Transactions" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/bankTransactions/stats": { "get": { "tags": ["Bank"], "summary": "Retrieving statistics of downloaded banking transactions related to the conversation", "description": "\nReturns statistics related to downloaded transactions. These statistics are returned for each account that has been shared as part of the conversation.\nThis information only occurs when the _bankTransactions_ section is defined when creating a conversation.\nand are available when the appropriate callback is received, or when the _bankTransactions_ status reaches _FINISHED_.\n\n## Query Parameter Description\nThe method supports the following query parameters:\n\n| Parameter | Example | Description |\n| --------- | ------- | ----------- |\n| dateFrom | 2020-09-17T11: 18: 21.999Z | The starting date for the scope of analyzed transactions in the format https://tools.ietf.org/html/rfc3339. The default value is the oldest available transaction. You can enter an earlier date, but only transactions that the user has shared will be included. |\n| dateTo | 2020-09-17T11: 18: 21.999Z | The end date for the range of analyzed transactions in the format https://tools.ietf.org/html/rfc3339. The default value is the latest available transaction. You can enter a later date, but only transactions that the user has shared will be included. |\n\n## Response Content Description\n\n::note\nReturned fields may be missing some information. For example, if only the account credits were\nselected when creating a conversation, the statistics do not contain information about the charges.\n::\n\nDetailed description of returned fields:\n\n| Parameter | Example | Description |\n|-----------------------------------------|------------------------------| ----------- |\n| dateFrom | 2020-09-16T10: 44: 51.544Z | The starting date of the search criteria, or the date of the first transaction for all bank accounts, if the criteria was empty. The field will not be presented if the starting date criterion is not specified and there are no transactions in the given search criteria. |\n| dateTo | 2020-09-16T10: 44: 51.544Z | End date of the search criteria, or the date of the last transaction for all bank accounts, if the criteria was empty. The field will not be presented if the end date criterion is not specified and there are no transactions in the given search criteria. |\n| items | - | A structure containing information about transaction statistics. Each element of this structure represents statistics from a separate bank account. |\n| items.dateFirst | 2020-06-16T00: 00: 00.000Z | Date of the first transaction in the range. |\n| items.dateLast | 2020-09-16T00: 00: 00.000Z | Date of the last transaction in the range. |\n| items.numberOfCreditTransactions | 12 | Number of bank account discretionary transactions. |\n| items.numberOfDebitTransactions | 12 | Number of debit transactions on the bank account. |\n| items.avgCreditPerMonth | 300,000 | Average value of credit transactions per month, presented in basic units - e.g. in grosze. The value will be available if the analyzed period is greater than 60 days. |\n| items.avgDebitPerMonth | 258000 | Average value of debit transactions per month, presented in basic units - e.g. in grosze. The value will be available if the analyzed period is greater than 60 days. |\n| items.avgCredit | 30,000 | Average value of bank account discretionary transactions, presented in basic units - e.g. in grosze. |\n| items.avgDebit | 40,000 | Average value of bank account debit transactions, presented in basic units - e.g. in grosze. |\n| items.maxCredit | 110000 | Maximum value of a bank account discretionary transaction, presented in basic units - e.g. in grosze. |\n| items.maxDebit | 132000 | The maximum value of the debit transaction from the bank account, presented in basic units - e.g. in grosze. |\n| items.accountId | PL68249000050000400075212326 | Account number. |\n| items.currency | PLN | Currency code for a given bank account. |\n\n ", "operationId": "getBankTransactionsStats", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "description": "Starting date", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2020-07-24T08:00:00Z" }, { "name": "dateTo", "in": "query", "description": "End date", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2020-08-24T00:00:00Z" } ], "responses": { "200": { "description": "Information available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/TransactionsStatistics" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/bankTransactions/accounts": { "get": { "tags": ["Bank"], "summary": "Retrieving information on bank accounts related to the conversation", "description": "\nReturns information about the accounts from which transactions have been downloaded.\nThis information occurs only when the _bankTransactions_ section was defined when creating a conversation.\nand are available when the appropriate callback is received, or when the _bankTransactions_ status reaches _FINISHED_.\n\n## Description of the Response Content\n\nDetailed description of returned fields:\n\n| Parameter | Example | Description |\n| --------- | ------- | ----------- |\n| date | 2020-09-17T11: 18: 21.999Z | Date on which the information was collected.|\n| balance | 10030 | Account balance in a currency unit, e.g. in pennies. The value determines the balance of funds available on the account or, if there is no such information, the balance of funds booked. It may not occur if the bank does not provide the balance. |\n| bank | BREXPLPW | Bank where the transaction was performed. The value identifies the bank as the SWIFT / BIC code. |\n| accountId | PL68249000050000400075212326 | Account number. |\n| currency | PLN | currency type |\n| activationDate | 2014-11-19 | The date when the account was opened or the date of the oldest transaction found. |\n\n ", "operationId": "getBankTransactionsAccounts", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account information available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/Accounts" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/aml/{list}": { "get": { "tags": ["AML"], "summary": "Retrieving detailed information about the user collected during the AML process", "description": "\nThe method retrieves data found in AML lists based on user data. Data from AML lists as defined when creating the conversation.\nWhen a continuous AML monitoring subscription is activated, only the latest available data is returned.\n\nWe can specify the list type in the query by specifying one of the following AML list types: `PEP`, `SIP`, `SANCTIONS`, `ADVERSE_MEDIA`, `OTHER`.\nDepending on the type of list you select, the structure of the response may vary.\n\n::note\nAML verification sources provide data in an inconsistent form, e.g., some dates and country names. We currently provide this data as received from the source, but in future we may unify them on Authologic side. This may change the format of the data available to the API.\n::\n\n### Response Parameters Available for PEP List Type\n\n| Parameter | Example | Description |\n|----------------------------------------|-----------------------------------------|------------------------------------------------------------------------------------------|\n| type | PERSON | Informs if entry describes user or users's relative: `PERSON` - user, `RCA` - users's relative |\n| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |\n| reason | -- | Reason why person is on the list |\n| user.person | -- | Data found on AML lists for provided person |\n| user.person.name.firstName | -- | User name |\n| user.person.name.lastName | -- | User surname |\n| user.person.name.middleName | -- | Second name |\n| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |\n| user.person.name.alsoKnownAs | -- | Alias names of person under verification |\n| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |\n| user.person.name.alsoKnownAs.lastName | -- | User's other surname |\n| user.person.name.alsoKnownAs.title | -- | User alias |\n| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |\n| user.person.info | -- | Additional information about the person under verification |\n| user.person.info.gender | MALE | The gender of the user: `MALE`, `FEMALE`, `OTHER` |\n| user.person.info.nationality | Poland (no unified country name format) | User's nationality |\n| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |\n| user.person.info.deceased | true/false | Information if person is dead |\n| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |\n| user.person.info.image | -- | URL to person's picture |\n| user.person.info.roles | -- | Information about the exposed position held by the person |\n| user.person.info.roles[].title | -- | Position held or `Unknown` if position is unknown |\n| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or 'Unknown' if country is unknown |\n| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |\n| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |\n\n### Response Parameters Available for SANCTIONS List Type\n\n| Parameter | Example | Description |\n|-----------------------------------------------------|---------|-----------------------------------------------------------------------------------------------|\n| type | PERSON | Informs if entry describes user or users's relative: `PERSON` - user, `RCA` - user's relative |\n| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |\n| reason | -- | Reason why person is on the list |\n| sources | -- | Names of AML list types on which the person was found |\n| user.person | -- | Data found on AML lists for provided person |\n| user.person.name.firstName | -- | User name |\n| user.person.name.lastName | -- | User surname |\n| user.person.name.middleName | -- | Second name |\n| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |\n| user.person.name.alsoKnownAs | -- | Alias names of person under verification |\n| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |\n| user.person.name.alsoKnownAs.lastName | -- | User's other surname |\n| user.person.name.alsoKnownAs.title | -- | User alias |\n| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |\n| user.person.info | -- | Additional information about the person under verification |\n| user.person.info.gender | MALE | The gender of the user: `MALE`, `FEMALE`, `OTHER` |\n| user.person.info.nationality | Poland (no unified country name format) | User's nationality |\n| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |\n| user.person.info.deceased | true/false | Information if person is dead |\n| user.person.info.deceaseDate | 2020-10-18 (no unified date format)| Date of death |\n| user.person.info.image | -- | URL to person's picture |\n| user.person.info.roles | -- | Information about the exposed position held by the person |\n| user.person.info.roles[].title | -- | Position held or 'Unknown' if position is unknown |\n| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or 'Unknown' if country is unknown |\n| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |\n| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |\n\n\n### Response Parameters Available for SIP List Type\n\n| Parameter | Example | Description |\n|-----------| ------- |----------------------------------------------------------------------------------------------|\n| type | PERSON | Informs if entry describes user or users's relative `PERSON` - user, `RCA` - user's relative |\n| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |\n| reason | -- | Reason why person is on the list |\n| user.person | -- | Data found on AML lists for provided person |\n| user.person.name.firstName | -- | User name |\n| user.person.name.lastName | -- | User surname |\n| user.person.name.middleName | -- | Second name |\n| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |\n| user.person.name.alsoKnownAs | -- | Alias names of person under verification |\n| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |\n| user.person.name.alsoKnownAs.lastName | -- | User's other surname |\n| user.person.name.alsoKnownAs.title | -- | User alias |\n| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |\n| user.person.info | -- | Additional information about the person under verification |\n| user.person.info.gender | `MALE` | The gender of the user: `MALE`, `FEMALE`, `OTHER` |\n| user.person.info.nationality | Poland (no unified country name format) | User's nationality |\n| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |\n| user.person.info.deceased | true/false | Information if person is dead |\n| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |\n| user.person.info.image | -- | URL to person's picture |\n| user.person.info.roles | -- | Information about the exposed position held by the person |\n| user.person.info.roles[].title | -- | Position held or 'Unknown' if position is unknown |\n| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or `Unknown` if country is unknown |\n| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |\n| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |\n\n### Response Parameters Available for ADVERSE_MEDIA List Type\n\n| Parameter | Example | Description |\n| --------- | ------- | ----------- |\n| originalUrl | -- | Link to adverse article |\n| date | 2020-10-18 (date format yyyy-MM-dd) | Adverse media publication date |\n| url | -- | Link to PDF with original adverse media publication |\n| categories | -- | Media categorization |\n\n### Response Parameters Available for OTHER List Type\n\n| Parameter | Example | Description |\n|-----------| ------- | ----------- |\n| type | PERSON | Informs if entry describes user or users's relative: `PERSON` - user, `RCA` - user's relative |\n| score | 0.98 | Compliance level of provided personal data with results (0-1 if provided or null) |\n| reason | -- | Reason why person is on the list |\n| user.person | -- | Data found on AML lists for provided person |\n| user.person.name.firstName | -- | User name |\n| user.person.name.lastName | -- | User surname |\n| user.person.name.middleName | -- | Second name |\n| user.person.name.spellings | -- | Correct spelling of name and surname (including national language) |\n| user.person.name.alsoKnownAs | -- | Alias names of person under verification |\n| user.person.name.alsoKnownAs.firstName | -- | User's other firstname |\n| user.person.name.alsoKnownAs.lastName | -- | User's other surname |\n| user.person.name.alsoKnownAs.title | -- | User alias |\n| user.person.address.country | POLAND (no unified country name format) | Country of residence of the person |\n| user.person.info | -- | Additional information about the person under verification |\n| user.person.info.gender | MALE | The gender of the user: `MALE`, `FEMALE`, `OTHER` |\n| user.person.info.nationality | Poland (no unified country name format) | User's nationality |\n| user.person.info.birthDate | 1972-10-18 (no unified date format) | Date of birth |\n| user.person.info.deceased | true/false | Information if person is dead |\n| user.person.info.deceaseDate | 2020-10-18 (no unified date format) | Date of death |\n| user.person.info.image | -- | URL to person's picture |\n| user.person.info.roles | -- | Information about the exposed position held by the person |\n| user.person.info.roles[].title | -- | Position held or `Unknown` if position is unknown |\n| user.person.info.roles[].country | (no unified country name format) | The country in which the position was held or `Unknown` if country is unknown |\n| user.person.info.roles[].fromDate | 2014-05-01 (no unified date format) | Start date of tenure |\n| user.person.info.roles[].tillDate | 2019 (no unified date format) | End date of tenure |\n\n\n ", "operationId": "getAMLList", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0 } }, { "name": "pageSize", "in": "query", "description": "The number of items on the page", "required": false, "schema": { "type": "integer", "format": "int32", "maximum": 200, "minimum": 1 } }, { "name": "list", "in": "path", "description": "List name", "required": true, "schema": { "type": "string", "enum": ["PEP", "SANCTIONS", "ADVERSE_MEDIA", "SIP", "OTHER"] }, "example": "SANCTIONS" } ], "responses": { "200": { "description": "User found on given AML list", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/AMLInfo" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/conversations/{conversationId}/affordability/info": { "get": { "tags": ["Affordability assessment"], "summary": "Retrieving the affordability assessment product information relating to the conversation", "description": "\nReturns information about how the affordability assessment validation process is performed for the given conversation ID.\nResults are available when the appropriate callback is received, or when the _affordabilityAssessment_ status reaches _FINISHED_.\n\n## Response Content \n\nDetailed description of returned fields:\n\n| Parameter | Example | Description |\n|---------------------------------------| ------- | ----------- |\n|personalInformation| - | A structure representing the set of personal data collected in affordability assessment validation process. |\n|personalInformation.firstName| Jan | Person's first name |\n|personalInformation.lastName|Kowalski| Person's last name |\n|personalInformation.fullName|Jan Kowalski| Person's full name |\n|personalInformation.birthDate|1985-07-20| Person's date of birth |,\n|personalInformation.address| - | A structure representing the set of address related data collected in affordability assessment validation process. |\n|personalInformation.address.text|Testowa 5 00-001 Warszawa Polska| Full adress |\n|personalInformation.address.addressLine|5| House number |\n|personalInformation.address.postalCode|00-001| Postal code |\n|personalInformation.address.city|Warszawa| City |\n|personalInformation.address.country|Polska| Country |\n|accountInformation| - | A structure representing the set of data related with account collected in affordability assessment validation process. |\n|accountInformation.account| - | List of account information. |\n|accountInformation.account.accountNumber|PL12345678901234567890123456| Account number |\n|accountInformation.account.bankName|Bank Millennium| Bank name |\n|accountInformation.account.accountType|Current| Account type/name |\n|accountInformation.account.balance|15450.75| Balance|\n|accountInformation.account.currency|EUR| Currency|\n|accountInformation.account.overdraft|true| Account has an overdraft |\n|sourceOfFundsInformation| - | A structure representing the set of data related with source of funds information collected in affordability assessment validation process. |\n|sourceOfFundsInformation.sourceOfFunds| - | List of sources. |\n|sourceOfFundsInformation.sourceOfFunds.type|Employment| Source type |\n|sourceOfFundsInformation.sourceOfFunds.name|Tech Solutions sp. z o.o.| Name of the institution which is the source of funds. |\n|sourceOfFundsInformation.sourceOfFunds.grossAmount|8500.0| Contract gross amount |\n|sourceOfFundsInformation.sourceOfFunds.netAmount|6120.5| Contract net amount |\n|sourceOfFundsInformation.sourceOfFunds.currency|EUR| Currency|\n|sourceOfFundsInformation.sourceOfFunds.currencyConversion.convertedAmount|4766.94| Net income after conversion to target currency |\n|sourceOfFundsInformation.sourceOfFunds.currencyConversion.targetCurrency|USD| Target currency |\n|sourceOfFundsInformation.sourceOfFunds.currencyConversion.convertedAmount|1.1770| Exchange rate applied by provider |\n|sourceOfFundsInformation.sourceOfFunds.frequency|Monthly| Payment frequency |\n|sourceOfFundsInformation.sourceOfFunds.contractType|Permanent| Type of the contract |\n|sourceOfFundsInformation.sourceOfFunds.contractEndDate|2099-12-31| Contract end date |\n|sourceOfFundsInformation.sourceOfFunds.partTimePercentage|1| Part of a full-time position covered by the agreement |\n|documentInformation| - | A structure representing the set of data related with document collected in affordability assessment validation process. |\n|documentInformation.type|EmploymentContract| Type of the collected document |\n|documentInformation.number|TS/KOW/2022/11| Number of the collected document |\n|documentInformation.issueDate|2022-11-01| Document issue date |\n|documentInformation.confidenceScore|0.95| Level of trust of the analysed document |\n|documentInformation.trustScore|0.7| Document Trust Index score |\n|documentInformation.periodStart|2023-01-01| Period start date that analysed document refers to |\n|documentInformation.periodEnd|2023-12-31| Period end date that analysed document refers to |\n|financialAnalysis| - | A structure representing the summary of affordability assessment validation. |\n|financialAnalysis.income|7500| Income summary |\n|financialAnalysis.expenditure|4200.5| Expenditure summary |\n|financialAnalysis.currency|EUR| Currency|\n", "operationId": "getAffordability", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transaction list available", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/Affordability" } } } }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "JSON body has an illegal format [Line: 10, Column: 12]: Unexpected character ('\"' (code 34)): was expecting Array entries.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied for strategy: `public:b`.", "violations": [] } } } }, "404": { "description": "Conversation not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "410": { "description": "Conversation is unavailable", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "GONE", "message": "Conversation is unavailable due to retention policy.", "violations": [] } } } }, "500": { "description": "Server side error" } } } }, "/api/subscriptions/{conversationId}/aml": { "delete": { "tags": ["AML"], "summary": "Cancel AML list subscription connected to the conversation", "description": "\nStops AML monitoring for given conversation.\n ", "operationId": "cancelAMLSubscription", "parameters": [ { "name": "conversationId", "in": "path", "description": "Conversation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Subscription canceled" }, "400": { "description": "Bad Request", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "type": "string", "oneOf": [ { "$ref": "#/components/schemas/BadRequestApiError" }, { "$ref": "#/components/schemas/MethodArgumentNotValidError" }, { "$ref": "#/components/schemas/MethodArgumentTypeMismatchError" }, { "$ref": "#/components/schemas/ConstraintViolationError" }, { "$ref": "#/components/schemas/CustomValidationApiError" }, { "$ref": "#/components/schemas/OperationNotSupportedApiFieldError" }, { "$ref": "#/components/schemas/MissingHeaderApiError" } ] }, "example": { "status": "BAD_REQUEST", "message": "AML subscription in conversation: `example_conversation_id` already inactive.", "violations": [] } } } }, "402": { "description": "Exhaustion of the plan or limitations related to non-payment" }, "403": { "description": "Forbidden", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "FORBIDDEN", "message": "Permission denied.", "violations": [] } } } }, "404": { "description": "Conversation or AML subscription not found", "content": { "application/vnd.authologic.v1.1+json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "status": "NOT_FOUND", "message": "Item not found", "violations": [] } } } }, "500": { "description": "Server side error" } } } } }, "components": { "schemas": { "AMLProduct": { "type": "object", "properties": { "checks": { "type": "array", "description": "List of AML checks to perform", "items": { "type": "string", "enum": ["PEP", "SANCTIONS", "ADVERSE_MEDIA", "SIP", "OTHER"] } }, "subscription": { "$ref": "#/components/schemas/AMLSubscription", "description": "The presence of the object enables recurring AML lists checking." }, "user": { "$ref": "#/components/schemas/AMLUserInfo", "description": "Individual's data in case of AML list check without KYC verification." } }, "required": ["checks"] }, "AMLSubscription": {}, "AMLUserInfo": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of person verified for AML.", "maxLength": 100, "minLength": 0 }, "lastName": { "type": "string", "description": "Last name of person verified for AML.", "maxLength": 200, "minLength": 0 }, "birthDate": { "type": "string", "format": "date", "description": "Date of birth of person verified for AML.", "example": "1999-10-09" }, "nationality": { "type": "string", "description": "Nationality of person verified for AML.", "example": "PL" }, "scriptName": { "type": "string", "description": "Individual's full name in original script text or the full Latin-based name.", "maxLength": 256, "minLength": 0 }, "nationalId": { "type": "string", "description": "User ID (in Poland: PESEL)", "example": "73121243XXX", "maxLength": 50, "minLength": 0 } } }, "AddressInfo": { "type": "object", "properties": { "text": { "type": "string", "description": "User's full address, not broken down into components. **Note:** This field has no format defined", "example": "ul. Wiśniowa 133/20 00-950 Warszawa PL", "maxLength": 200, "minLength": 0 }, "addressLine": { "type": "string", "description": "User address", "example": "ul. Wiśniowa 133/20", "maxLength": 200, "minLength": 0 }, "postalCode": { "type": "string", "description": "Postcode", "example": "00-950", "maxLength": 10, "minLength": 0 }, "city": { "type": "string", "description": "City", "example": "Warszawa", "maxLength": 100, "minLength": 0 }, "country": { "type": "string", "description": "Country", "example": "PL", "maxLength": 100, "minLength": 0 }, "state": { "type": "string", "description": "State/province", "example": "California", "maxLength": 200, "minLength": 0 } } }, "AffordabilityProduct": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/AffordabilityUserInfo", "description": "Individual's data in case of affordability assessment check without KYC verification." } } }, "AffordabilityUserInfo": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of person verified for affordability product.", "maxLength": 100, "minLength": 1 }, "lastName": { "type": "string", "description": "Last name of person verified for affordability product.", "maxLength": 128, "minLength": 1 }, "birthDate": { "type": "string", "format": "date", "description": "Date of birth of person verified for affordability product.", "example": "1999-10-09" }, "postalCode": { "type": "string", "description": "Postcode", "example": "00-950", "maxLength": 12, "minLength": 1 }, "houseNumber": { "type": "string", "description": "House number", "example": 123, "maxLength": 10, "minLength": 1 }, "country": { "type": "string", "description": "Country of residence of person verified for affordability product.", "example": "PL" }, "email": { "type": "string", "description": "E-mail of person verified for affordability product.", "example": "email@example.com", "maxLength": 254, "minLength": 4 } }, "required": ["country"] }, "AgeVerificationProduct": { "type": "object", "properties": { "over": { "type": "integer", "format": "int32", "description": "Age to verify against.", "example": 18, "maximum": 150, "minimum": 1 } }, "required": ["over"] }, "AuthProduct": { "type": "object", "properties": { "challenge": { "type": "string", "description": "Equivalent of a user's login in a given method." } } }, "BankTransactionsProduct": { "type": "object", "properties": { "type": { "type": "string", "description": "Transaction type to be retrieved:\n* CREDIT - credit\n* DEBIT - debit\n* ALL - all types\n", "enum": ["CREDIT", "DEBIT", "ALL"] }, "flags": { "type": "array", "items": { "type": "string", "enum": ["INCLUDE_SCHEDULED", "INCLUDE_TAGS"] }, "uniqueItems": true } }, "required": ["flags", "type"] }, "CompanyAccountInfo": { "type": "object", "description": "Company account information", "properties": { "swiftbic": { "type": "string", "description": "Bank's SWIFT / BIC code", "example": "BREXPLPW", "maxLength": 50, "minLength": 0 }, "accountId": { "type": "string", "description": "Company account identification number", "example": "PL27114020040000300201355387", "maxLength": 50, "minLength": 0 }, "currency": { "type": "string", "description": "Account currency", "example": "PLN", "maxLength": 3, "minLength": 0 } } }, "CompanyIds": { "type": "object", "properties": { "taxId": { "type": "string", "description": "Tax identification number (in Poland: NIP) of the company", "example": 1234567890, "maxLength": 50, "minLength": 0 }, "additionalId": { "type": "string", "description": "Additional identifier", "example": "A03015512", "maxLength": 50, "minLength": 0 }, "accounts": { "type": "array", "description": "Company account list", "items": { "$ref": "#/components/schemas/CompanyAccountInfo" } } }, "required": ["accounts"] }, "CompanyName": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name", "example": "ACME Inc.", "maxLength": 200, "minLength": 0 } } }, "CompanyUserInfo": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/CompanyName", "description": "Contains information related to the identification of the company if the current user is a legal entity" }, "ids": { "$ref": "#/components/schemas/CompanyIds", "description": "Contains company-related identifiers if the current user is a legal entity" }, "address": { "$ref": "#/components/schemas/AddressInfo", "description": "User address" }, "contact": { "$ref": "#/components/schemas/ContactInfo", "description": "User contact details" } } }, "ContactInfo": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "User's email address", "example": "jan.kowalski@email.com" }, "phone": { "type": "string", "description": "User's phone", "example": "+48692887345" }, "emailOtp": { "type": "string", "format": "email", "description": "User's email address confirmed with one time password", "example": "jan.kowalski@email.com" }, "phoneOtp": { "type": "string", "description": "User's phone confirmed with one time password", "example": "+48692887345" } } }, "CreateConversation": { "type": "object", "properties": { "userKey": { "type": "string", "description": "User ID on your system. This property is not used by the Authologic and is returned with the conversation status. If not given will be generated automatically. ", "example": "7dfb9ded-c38f-49ae-95e2-307283a0b1f6", "maxLength": 200, "minLength": 1, "pattern": "^[a-zA-Z0-9-_+=#@.:]+$" }, "returnUrl": { "type": "string", "description": "The address on your system where the user will be redirected after verifying his identity. If {conversationId} part was given,\nit will be replaced with the conversation ID", "example": "https://authologic.com/tests/return/?conversation={conversationId}" }, "callbackUrl": { "type": "string", "description": "The address in your system to which information about the user will be sent. You can use placeholders: {conversationId}, {target} and {event}", "example": "https://authologic.com/tests/callback/?conversation={conversationId}&target={target}&event={event}" }, "layoutUrl": { "type": "string", "description": "The address on your system where the user will be redirected when Authologic need contact with user. This allows to define process look on your side.\n If {conversationId} part was given, it will be replaced with the conversation ID", "example": "https://authologic.com/tests/layout/?conversation={conversationId}" }, "strategy": { "type": "string", "description": "Additional information on the user identity verification strategy", "example": "public:default", "pattern": "^[a-zA-Z]+:[a-zA-Z0-9-_+:]+$" }, "query": { "$ref": "#/components/schemas/ProductQuery", "description": "Query definition - List of information to be obtained" }, "settings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional, optional settings depend on the selected strategy.", "example": { "countryCode": "PL" } } } }, "DriverLicenceInfo": { "type": "object", "description": "User's driver licence", "properties": { "id": { "type": "string", "description": "Number", "example": "AA 12343454", "maxLength": 50, "minLength": 0 }, "issueDate": { "type": "string", "format": "date", "description": "Date of issue of the document" }, "expiryDate": { "type": "string", "format": "date", "description": "Document expiry date" }, "issueCountry": { "type": "string", "description": "Country of issue of the document", "example": "GB" }, "issueState": { "type": "string", "description": "State/province of issue of the document", "example": "California" }, "issuer": { "type": "string", "description": "Authority issuing the document", "example": "Prezydent m.st. Warszawy" }, "additionalId": { "type": "string", "description": "Additional identifier", "example": "A03015512" }, "limitations": { "type": "array", "description": "Limitations", "example": ["01.06", "61"], "items": { "type": "string" } }, "documentStatus": { "type": "string", "description": "Document status", "enum": ["RELEASED", "SUSPENDED", "DESTROYED", "LOST", "CANCELED"], "example": "RELEASED" }, "categories": { "type": "array", "description": "Available categories", "items": { "$ref": "#/components/schemas/DriverLicenceInfoCategory" } } } }, "DriverLicenceInfoCategory": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "LIGHT_MOPEDS_AND_QUADRICYCLES", "LIGHT_MOTORCYCLES", "MEDIUM_POWERED_MOTORCYCLES", "UNRESTRICTED_MOTORCYCLES", "LIGHT_VEHICLES", "CARS", "MEDIUM_SIZED_VEHICLES", "LARGE_VEHICLES", "MINIBUSES", "BUSES", "ARTICULATED_VEHICLES_OR_TRAILERS", "MOTORCYCLES_AND_CARS", "CAR_WITH_TRAILER", "LARGE_VEHICLE_WITH_TRAILER", "BUS_WITH_TRAILER" ] }, "issueDate": { "type": "string", "format": "date" }, "expiryDate": { "type": "string", "format": "date" }, "limitations": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["ACTIVE", "REVOKE"] } } }, "EnquiryProduct": { "type": "object", "properties": { "formId": { "type": "string", "description": "Form identifier." } } }, "IdCardInfo": { "type": "object", "description": "User's ID card", "properties": { "id": { "type": "string", "description": "Number", "example": "ABC 12343", "maxLength": 50, "minLength": 0 }, "type": { "type": "string", "description": "Type od ID card, as it may be different depending on country", "example": "Aadhaar", "maxLength": 30, "minLength": 0 }, "issueDate": { "type": "string", "format": "date", "description": "Date of issue of the document" }, "expiryDate": { "type": "string", "format": "date", "description": "Document expiry date" }, "issueCountry": { "type": "string", "description": "Country of issue of the document", "example": "GB" }, "issuer": { "type": "string", "description": "Authority issuing the document", "example": "Prezydent m.st. Warszawy" } } }, "IdentityProduct": { "type": "object", "properties": { "requireOneOf": { "type": "array", "items": { "type": "array", "items": { "type": "string", "enum": [ "PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME", "PERSON_NAME_MIDDLENAME", "PERSON_NAME_MIDDLE_INITIAL", "PERSON_NAME_FULLNAME", "PERSON_NAME_MOTHER_NAME", "PERSON_NAME_FATHER_NAME", "PERSON_NAME_SPELLING", "PERSON_IDS_NATIONAL_ID", "PERSON_IDS_ACCOUNTS", "PERSON_IDS_IDCARD_ID", "PERSON_IDS_IDCARD_TYPE", "PERSON_IDS_IDCARD_PHOTO", "PERSON_IDS_IDCARD_ISSUE_DATE", "PERSON_IDS_IDCARD_EXPIRY_DATE", "PERSON_IDS_IDCARD_ISSUE_COUNTRY", "PERSON_IDS_IDCARD_ISSUER", "PERSON_IDS_PASSPORT_ID", "PERSON_IDS_PASSPORT_ISSUE_DATE", "PERSON_IDS_PASSPORT_EXPIRY_DATE", "PERSON_IDS_PASSPORT_PHOTO", "PERSON_IDS_PASSPORT_ISSUE_COUNTRY", "PERSON_IDS_PASSPORT_ISSUER", "PERSON_IDS_RESIDENCE_PERMIT_ID", "PERSON_IDS_RESIDENCE_PERMIT_TYPE", "PERSON_IDS_RESIDENCE_PERMIT_ISSUE_DATE", "PERSON_IDS_RESIDENCE_PERMIT_EXPIRY_DATE", "PERSON_IDS_RESIDENCE_PERMIT_PHOTO", "PERSON_IDS_RESIDENCE_PERMIT_ISSUE_COUNTRY", "PERSON_IDS_RESIDENCE_PERMIT_ISSUER", "PERSON_IDS_DRIVER_LICENCE_ID", "PERSON_IDS_DRIVER_LICENCE_ISSUE_DATE", "PERSON_IDS_DRIVER_LICENCE_EXPIRY_DATE", "PERSON_IDS_DRIVER_LICENCE_PHOTO", "PERSON_IDS_DRIVER_LICENCE_ISSUE_COUNTRY", "PERSON_IDS_DRIVER_LICENCE_ISSUE_STATE", "PERSON_IDS_DRIVER_LICENCE_ISSUER", "PERSON_IDS_DRIVER_LICENCE_CATEGORIES", "PERSON_IDS_DRIVER_LICENCE_ADDITIONAL_ID", "PERSON_IDS_DRIVER_LICENCE_LIMITATIONS", "PERSON_IDS_DRIVER_LICENCE_DOCUMENT_STATUS", "PERSON_IDS_OTHER_DOCUMENT_ID", "PERSON_IDS_OTHER_DOCUMENT_DESCRIPTION", "PERSON_IDS_OTHER_DOCUMENT_ISSUE_DATE", "PERSON_IDS_OTHER_DOCUMENT_EXPIRY_DATE", "PERSON_IDS_OTHER_DOCUMENT_ISSUE_COUNTRY", "PERSON_IDS_OTHER_DOCUMENT_ISSUER", "PERSON_IDS_OTHER_DOCUMENT_PHOTO", "PERSON_INFO_GENDER", "PERSON_INFO_NATIONALITY", "PERSON_INFO_BIRTHDATE", "PERSON_INFO_BIRTH_CITY", "PERSON_INFO_BIRTH_COUNTRY", "PERSON_INFO_AGE", "PERSON_INFO_FOREIGNER_STATUS", "COMPANY_NAME_NAME", "COMPANY_IDS_TAX_ID", "PERSON_ADDRESS", "COMPANY_ADDRESS", "PERSON_CONTACT_EMAIL", "PERSON_CONTACT_PHONE", "PERSON_CONTACT_EMAIL_OTP", "PERSON_CONTACT_PHONE_OTP", "COMPANY_CONTACT_EMAIL", "COMPANY_CONTACT_PHONE", "COMPANY_IDS_ADDITIONAL_ID", "COMPANY_IDS_ACCOUNTS" ] }, "uniqueItems": true }, "uniqueItems": true }, "optional": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProductOptionalField" }, "uniqueItems": true } } }, "IdentityProductOptionalField": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "string", "enum": [ "PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME", "PERSON_NAME_MIDDLENAME", "PERSON_NAME_MIDDLE_INITIAL", "PERSON_NAME_FULLNAME", "PERSON_NAME_MOTHER_NAME", "PERSON_NAME_FATHER_NAME", "PERSON_NAME_SPELLING", "PERSON_IDS_NATIONAL_ID", "PERSON_IDS_ACCOUNTS", "PERSON_IDS_IDCARD_ID", "PERSON_IDS_IDCARD_TYPE", "PERSON_IDS_IDCARD_PHOTO", "PERSON_IDS_IDCARD_ISSUE_DATE", "PERSON_IDS_IDCARD_EXPIRY_DATE", "PERSON_IDS_IDCARD_ISSUE_COUNTRY", "PERSON_IDS_IDCARD_ISSUER", "PERSON_IDS_PASSPORT_ID", "PERSON_IDS_PASSPORT_ISSUE_DATE", "PERSON_IDS_PASSPORT_EXPIRY_DATE", "PERSON_IDS_PASSPORT_PHOTO", "PERSON_IDS_PASSPORT_ISSUE_COUNTRY", "PERSON_IDS_PASSPORT_ISSUER", "PERSON_IDS_RESIDENCE_PERMIT_ID", "PERSON_IDS_RESIDENCE_PERMIT_TYPE", "PERSON_IDS_RESIDENCE_PERMIT_ISSUE_DATE", "PERSON_IDS_RESIDENCE_PERMIT_EXPIRY_DATE", "PERSON_IDS_RESIDENCE_PERMIT_PHOTO", "PERSON_IDS_RESIDENCE_PERMIT_ISSUE_COUNTRY", "PERSON_IDS_RESIDENCE_PERMIT_ISSUER", "PERSON_IDS_DRIVER_LICENCE_ID", "PERSON_IDS_DRIVER_LICENCE_ISSUE_DATE", "PERSON_IDS_DRIVER_LICENCE_EXPIRY_DATE", "PERSON_IDS_DRIVER_LICENCE_PHOTO", "PERSON_IDS_DRIVER_LICENCE_ISSUE_COUNTRY", "PERSON_IDS_DRIVER_LICENCE_ISSUE_STATE", "PERSON_IDS_DRIVER_LICENCE_ISSUER", "PERSON_IDS_DRIVER_LICENCE_CATEGORIES", "PERSON_IDS_DRIVER_LICENCE_ADDITIONAL_ID", "PERSON_IDS_DRIVER_LICENCE_LIMITATIONS", "PERSON_IDS_DRIVER_LICENCE_DOCUMENT_STATUS", "PERSON_IDS_OTHER_DOCUMENT_ID", "PERSON_IDS_OTHER_DOCUMENT_DESCRIPTION", "PERSON_IDS_OTHER_DOCUMENT_ISSUE_DATE", "PERSON_IDS_OTHER_DOCUMENT_EXPIRY_DATE", "PERSON_IDS_OTHER_DOCUMENT_ISSUE_COUNTRY", "PERSON_IDS_OTHER_DOCUMENT_ISSUER", "PERSON_IDS_OTHER_DOCUMENT_PHOTO", "PERSON_INFO_GENDER", "PERSON_INFO_NATIONALITY", "PERSON_INFO_BIRTHDATE", "PERSON_INFO_BIRTH_CITY", "PERSON_INFO_BIRTH_COUNTRY", "PERSON_INFO_AGE", "PERSON_INFO_FOREIGNER_STATUS", "COMPANY_NAME_NAME", "COMPANY_IDS_TAX_ID", "PERSON_ADDRESS", "COMPANY_ADDRESS", "PERSON_CONTACT_EMAIL", "PERSON_CONTACT_PHONE", "PERSON_CONTACT_EMAIL_OTP", "PERSON_CONTACT_PHONE_OTP", "COMPANY_CONTACT_EMAIL", "COMPANY_CONTACT_PHONE", "COMPANY_IDS_ADDITIONAL_ID", "COMPANY_IDS_ACCOUNTS" ] }, "uniqueItems": true } }, "required": ["list"] }, "KnownUserInfo": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/CompanyUserInfo", "description": "Contains company-related information if the current user is a legal entity" }, "person": { "$ref": "#/components/schemas/PersonUserInfo", "description": "Contains user-related information if the current user is a natural person" } } }, "OtherDocumentInfo": { "type": "object", "description": "Other document (only applies to specific verification methods)", "properties": { "id": { "type": "string", "description": "Number", "example": "AA 12343454", "maxLength": 1024, "minLength": 0 }, "description": { "type": "string", "description": "Description", "example": "Document ID", "maxLength": 1024, "minLength": 0 }, "issueDate": { "type": "string", "format": "date", "description": "Date of issue of the document" }, "expiryDate": { "type": "string", "format": "date", "description": "Document expiry date" }, "issueCountry": { "type": "string", "description": "Country of issue of the document", "example": "GB" }, "issuer": { "type": "string", "description": "Authority issuing the document", "example": "Prezydent m.st. Warszawy" } } }, "PassportInfo": { "type": "object", "description": "User's passport", "properties": { "id": { "type": "string", "description": "Number", "example": "AD 24243423", "maxLength": 50, "minLength": 0 }, "issueDate": { "type": "string", "format": "date", "description": "Date of issue of the document" }, "expiryDate": { "type": "string", "format": "date", "description": "Document expiry date" }, "issueCountry": { "type": "string", "description": "Country of issue of the document", "example": "GB" }, "issuer": { "type": "string", "description": "Authority issuing the document", "example": "Wojewoda Mazowiecki" } } }, "PersonAccountInfo": { "type": "object", "description": "User account information", "properties": { "swiftbic": { "type": "string", "description": "Bank's SWIFT / BIC code", "example": "BREXPLPW", "maxLength": 50, "minLength": 0 }, "accountId": { "type": "string", "description": "User account identification number", "example": "PL27114020040000300201355387", "maxLength": 50, "minLength": 0 }, "currency": { "type": "string", "description": "Account currency", "example": "PLN", "maxLength": 3, "minLength": 0 } } }, "PersonIdsInfo": { "type": "object", "properties": { "nationalId": { "type": "string", "description": "User ID (in Poland: PESEL)", "example": 73121243192, "maxLength": 50, "minLength": 0 }, "idCard": { "$ref": "#/components/schemas/IdCardInfo", "description": "ID card" }, "passport": { "$ref": "#/components/schemas/PassportInfo", "description": "Passport" }, "driverLicence": { "$ref": "#/components/schemas/DriverLicenceInfo", "description": "Driver Licence" }, "residencePermit": { "$ref": "#/components/schemas/ResidencePermitInfo", "description": "Residence permit" }, "otherDocument": { "$ref": "#/components/schemas/OtherDocumentInfo", "description": "Other document (only applies to specific verification methods)" }, "accounts": { "type": "array", "description": "User account list", "items": { "$ref": "#/components/schemas/PersonAccountInfo" } } }, "required": ["accounts"] }, "PersonInfoInfo": { "type": "object", "properties": { "gender": { "type": "string", "description": "The gender of the user (MALE/FEMALE/OTHER)", "enum": ["MALE", "FEMALE", "OTHER"] }, "nationality": { "type": "string", "description": "User's nationality", "example": "PL" }, "birthDate": { "type": "string", "format": "date", "description": "Date of birth" }, "birthCity": { "type": "string", "description": "Place of birth", "example": "Gdańsk", "maxLength": 200, "minLength": 0 }, "birthCountry": { "type": "string", "description": "Country of birth", "example": "PL" }, "age": { "type": "integer", "format": "int32", "description": "Age", "example": 25 }, "foreignerStatus": { "type": "string", "description": "Foreigner status", "example": "UKR", "maxLength": 50, "minLength": 0 } } }, "PersonName": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan", "maxLength": 100, "minLength": 0 }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski", "maxLength": 200, "minLength": 0 }, "middleName": { "type": "string", "description": "Second name", "example": "Stanisław", "maxLength": 100, "minLength": 0 }, "middleInitial": { "type": "string", "description": "Middle initial", "example": "S", "maxLength": 1, "minLength": 0 }, "fullName": { "type": "string", "description": "User full name", "example": "Jan Stanisław Kowalski", "maxLength": 300, "minLength": 0 }, "motherName": { "type": "string", "description": "Mother's name", "example": "Anna", "maxLength": 100, "minLength": 0 }, "fatherName": { "type": "string", "description": "Father's name", "example": "Tomasz", "maxLength": 100, "minLength": 0 }, "spelling": { "$ref": "#/components/schemas/Spelling", "description": "Object containing alternative spelling variations, legally recognized aliases, and official transliterations or romanizations of the individual's name" } } }, "PersonUserInfo": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PersonName", "description": "Contains information related to the identification of the user, if the current user is a natural person" }, "ids": { "$ref": "#/components/schemas/PersonIdsInfo", "description": "Contains identifiers associated with the user if the current user is a natural person" }, "info": { "$ref": "#/components/schemas/PersonInfoInfo", "description": "Contains additional information about the user" }, "address": { "$ref": "#/components/schemas/AddressInfo", "description": "User address" }, "contact": { "$ref": "#/components/schemas/ContactInfo", "description": "User contact details" } } }, "ProductQuery": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/IdentityProduct", "description": "Configures the required user information to be provided" }, "verify": { "$ref": "#/components/schemas/VerifyProduct", "description": "Configures which user information should be compared and verified" }, "bankTransactions": { "$ref": "#/components/schemas/BankTransactionsProduct", "description": "Configures the required information about the user's banking transactions." }, "aml": { "$ref": "#/components/schemas/AMLProduct", "description": "Configures the required information about the AML checks." }, "auth": { "$ref": "#/components/schemas/AuthProduct", "description": "Configures the required information about auth product." }, "enquiry": { "$ref": "#/components/schemas/EnquiryProduct", "description": "Configures the required information about enquiry product." }, "affordability": { "$ref": "#/components/schemas/AffordabilityProduct", "description": "Configures the required information about affordability product." }, "ageVerification": { "$ref": "#/components/schemas/AgeVerificationProduct", "description": "[BETA] Configures the required information about age verification product." } } }, "ResidencePermitInfo": { "type": "object", "description": "User's residence permit", "properties": { "id": { "type": "string", "description": "Number", "example": "AD 24243423", "maxLength": 50, "minLength": 0 }, "issueDate": { "type": "string", "format": "date", "description": "Date of issue of the document" }, "expiryDate": { "type": "string", "format": "date", "description": "Document expiry date" }, "issueCountry": { "type": "string", "description": "Country of issue of the document", "example": "GB" }, "issuer": { "type": "string", "description": "Authority issuing the document", "example": "Wojewoda Mazowiecki" } } }, "Spelling": { "type": "object", "properties": { "aliasName": { "type": "string", "description": "The legally recognized alternate name or pseudonym of the individual", "example": "Mark Twain", "maxLength": 300, "minLength": 0 }, "translatedName": { "type": "string", "description": "The official translation or transliteration of the individual's core name from its original script/language into standard Latin characters", "example": "Samuel Clemens", "maxLength": 300, "minLength": 0 }, "translatedAlias": { "type": "string", "description": "The legally recognized alternate name (alias) converted into its official translated or transliterated form using Latin characters", "example": "Mark Tven", "maxLength": 300, "minLength": 0 } } }, "VerifyProduct": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/KnownUserInfo", "description": "List of information about a user to verify" } }, "required": ["user"] }, "ConversationInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the conversation", "example": "e0c0b3cc-8238-414f-9940-9f14bd1b8693" }, "userKey": { "type": "string", "description": "Unique user identifier in the Customer's system", "example": "d5dbb8e0-192e-4bc6-972c-f7948409d10c" }, "url": { "type": "string", "description": "The address where user should be redirected to perform the verification", "example": "https://sandbox.authologic.com/c/022e8eaf-b06d-44b9-a68f-45eef1353dbe" }, "status": { "type": "string", "description": "Conversation state\n* CREATED - conversation ready to be run\n* IN_PROGRESS - data is being determined from the query\n* FINISHED - query checks have been completed\n* CANCELED - checking interrupted by the user\n* EXPIRED - conversation is expired\n", "enum": ["CREATED", "IN_PROGRESS", "FINISHED", "CANCELED", "EXPIRED"], "example": "CREATED" }, "result": { "$ref": "#/components/schemas/ConversationInfoResult", "description": "The result of checking individual elements", "title": "ConversationResult" }, "info": { "type": "array", "description": "The information about activated strategy elements", "items": { "$ref": "#/components/schemas/ConversationStrategyInfo" }, "title": "ConversationInfo" } }, "required": ["id", "result", "status", "url", "userKey"], "title": "Conversation" }, "ConversationInfoAMLProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* PARTIAL - checking completed but only some data could be identified\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "found": { "type": "array", "description": "AML lists, where matching records were found", "items": { "type": "string", "enum": ["PEP", "SANCTIONS", "ADVERSE_MEDIA", "SIP", "OTHER"] }, "readOnly": true, "uniqueItems": true }, "subscription": { "$ref": "#/components/schemas/SubscribedProduct", "description": "Information about the periodic checking of lists", "readOnly": true } }, "required": ["found", "status"] }, "ConversationInfoAffordabilityProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "errors": { "type": "array", "description": "Additional information on possible causes of verification failure", "items": { "type": "string" }, "readOnly": true, "uniqueItems": true } }, "required": ["status"] }, "ConversationInfoAgeVerificationProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "over": { "type": "integer", "format": "int32", "description": "Declared age to verify against.", "readOnly": true }, "result": { "type": "boolean", "description": "Age verification result. True if the user's age meets the declared threshold.", "readOnly": true } }, "required": ["over", "status"] }, "ConversationInfoAuthProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* PARTIAL - checking completed but only some data could be identified\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "token": { "type": "string", "description": "Authorization token.", "readOnly": true }, "challenge": { "type": "string", "description": "Equivalent of a user's login in a given method.", "readOnly": true } }, "required": ["status"] }, "ConversationInfoBankTransactionsProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* PARTIAL - checking completed but only some data could be identified\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true } }, "required": ["status"] }, "ConversationInfoIdentityProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* PARTIAL - checking completed but only some data could be identified\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "errors": { "type": "array", "description": "Additional information on possible causes of verification failure", "items": { "type": "string" }, "readOnly": true, "uniqueItems": true }, "user": { "$ref": "#/components/schemas/DiscoveredUserInfo", "description": "Data discovered during identity checks", "readOnly": true }, "checks": { "type": "array", "description": "Additional information about the validations performed and their results", "items": { "$ref": "#/components/schemas/ConversationProductValidationResult" }, "readOnly": true } }, "required": ["status", "user"] }, "ConversationInfoResult": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/ConversationInfoIdentityProductResult", "description": "Identity check result", "title": "ConversationIdentityResult" }, "verify": { "$ref": "#/components/schemas/ConversationInfoVerifyProductResult", "description": "Verify step result", "title": "ConversationVerifyResult" }, "bankTransactions": { "$ref": "#/components/schemas/ConversationInfoBankTransactionsProductResult", "description": "The result of retrieving transaction data", "title": "ConversationBankTransactionsResult" }, "aml": { "$ref": "#/components/schemas/ConversationInfoAMLProductResult", "description": "The result of AML checks", "title": "ConversationAMLResult" }, "auth": { "$ref": "#/components/schemas/ConversationInfoAuthProductResult", "description": "The result of authorization", "title": "ConversationAuthResult" }, "enquiry": { "$ref": "#/components/schemas/ConversationProductEnquiryResult", "description": "The result of enquiry form", "title": "ConversationEnquiryResult" }, "affordability": { "$ref": "#/components/schemas/ConversationInfoAffordabilityProductResult", "description": "The result of affordability assessment product", "title": "ConversationInfoAffordabilityProductResult" }, "ageVerification": { "$ref": "#/components/schemas/ConversationInfoAgeVerificationProductResult", "description": "[BETA] The result of age verification", "title": "ConversationAgeVerificationResult" } } }, "ConversationInfoVerifyProductResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - checking in progress\n* FINISHED - checking completed\n* PARTIAL - checking completed but only some data could be identified\n* FAILED - checking completed but no data could be determined\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "reliability": { "type": "number", "format": "double", "description": "Information about how closely the output matches the input data", "maximum": 1, "minimum": 0, "readOnly": true }, "details": { "type": "array", "description": "detailed information about how closely given fields matches the input data", "items": { "$ref": "#/components/schemas/VerifyProductResultDetailInfo" }, "readOnly": true } }, "required": ["status"] }, "ConversationProductEnquiryResult": { "type": "object", "properties": { "status": { "type": "string", "description": "Result status:\n* IN_PROGRESS - enquiry in progress\n* FINISHED - enquiry completed\n* PARTIAL - enquiry completed but only some data was retrieved\n* FAILED - enquiry completed but failed to retrieve required data\n", "enum": ["IN_PROGRESS", "FINISHED", "FAILED", "PARTIAL"], "example": "FINISHED", "readOnly": true }, "formId": { "type": "string", "description": "Enquiry form identifier.", "readOnly": true }, "formData": { "type": "object", "additionalProperties": {}, "description": "Enquiry form data.", "readOnly": true } }, "required": ["status"] }, "ConversationProductValidationResult": { "type": "object", "properties": { "name": { "type": "string", "description": "Validator name.", "readOnly": true }, "result": { "type": "string", "description": "Validation result.", "enum": ["ACCEPTED", "FAILED", "ERROR"], "readOnly": true }, "details": { "type": "object", "additionalProperties": {}, "description": "Validation details.", "readOnly": true } }, "required": ["details", "name", "result"] }, "ConversationStrategyInfo": { "type": "object", "properties": { "country": { "type": "string", "description": "Country used.", "example": "PL", "readOnly": true }, "method": { "type": "string", "description": "Verification method used.\n* PSD2,\n* TRANSFER,\n* MOBYWATEL,\n* MOJEID_PL,\n* EDO_APP\n\n* and many more\n ", "example": "PSD2", "readOnly": true }, "trace": { "type": "object", "additionalProperties": {}, "description": "Additional information returned by the provider.", "readOnly": true }, "methodDetails": { "type": "object", "additionalProperties": {}, "description": "Additional information about verification method.", "readOnly": true } } }, "DiscoveredUserInfo": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/PersonUserInfo", "description": "Contains user-related information if the current user is a natural person" }, "company": { "$ref": "#/components/schemas/CompanyUserInfo", "description": "Contains company-related information if the current user is a legal entity" } } }, "SubscribedProduct": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Information whether the subscription is active.", "readOnly": true }, "lastChanged": { "type": "string", "format": "date-time", "description": "Date of the last change in the subscribed data.", "readOnly": true } }, "required": ["active"] }, "VerifyProductResultDetailInfo": { "type": "object", "properties": { "field": { "type": "string", "description": "The field to which the data relate", "enum": [ "PERSON_NAME_FIRSTNAME", "PERSON_NAME_LASTNAME", "PERSON_NAME_MIDDLENAME", "PERSON_NAME_MIDDLE_INITIAL", "PERSON_NAME_FULLNAME", "PERSON_NAME_MOTHER_NAME", "PERSON_NAME_FATHER_NAME", "PERSON_NAME_SPELLING", "PERSON_IDS_NATIONAL_ID", "PERSON_IDS_ACCOUNTS", "PERSON_IDS_IDCARD_ID", "PERSON_IDS_IDCARD_TYPE", "PERSON_IDS_IDCARD_PHOTO", "PERSON_IDS_IDCARD_ISSUE_DATE", "PERSON_IDS_IDCARD_EXPIRY_DATE", "PERSON_IDS_IDCARD_ISSUE_COUNTRY", "PERSON_IDS_IDCARD_ISSUER", "PERSON_IDS_PASSPORT_ID", "PERSON_IDS_PASSPORT_ISSUE_DATE", "PERSON_IDS_PASSPORT_EXPIRY_DATE", "PERSON_IDS_PASSPORT_PHOTO", "PERSON_IDS_PASSPORT_ISSUE_COUNTRY", "PERSON_IDS_PASSPORT_ISSUER", "PERSON_IDS_RESIDENCE_PERMIT_ID", "PERSON_IDS_RESIDENCE_PERMIT_TYPE", "PERSON_IDS_RESIDENCE_PERMIT_ISSUE_DATE", "PERSON_IDS_RESIDENCE_PERMIT_EXPIRY_DATE", "PERSON_IDS_RESIDENCE_PERMIT_PHOTO", "PERSON_IDS_RESIDENCE_PERMIT_ISSUE_COUNTRY", "PERSON_IDS_RESIDENCE_PERMIT_ISSUER", "PERSON_IDS_DRIVER_LICENCE_ID", "PERSON_IDS_DRIVER_LICENCE_ISSUE_DATE", "PERSON_IDS_DRIVER_LICENCE_EXPIRY_DATE", "PERSON_IDS_DRIVER_LICENCE_PHOTO", "PERSON_IDS_DRIVER_LICENCE_ISSUE_COUNTRY", "PERSON_IDS_DRIVER_LICENCE_ISSUE_STATE", "PERSON_IDS_DRIVER_LICENCE_ISSUER", "PERSON_IDS_DRIVER_LICENCE_CATEGORIES", "PERSON_IDS_DRIVER_LICENCE_ADDITIONAL_ID", "PERSON_IDS_DRIVER_LICENCE_LIMITATIONS", "PERSON_IDS_DRIVER_LICENCE_DOCUMENT_STATUS", "PERSON_IDS_OTHER_DOCUMENT_ID", "PERSON_IDS_OTHER_DOCUMENT_DESCRIPTION", "PERSON_IDS_OTHER_DOCUMENT_ISSUE_DATE", "PERSON_IDS_OTHER_DOCUMENT_EXPIRY_DATE", "PERSON_IDS_OTHER_DOCUMENT_ISSUE_COUNTRY", "PERSON_IDS_OTHER_DOCUMENT_ISSUER", "PERSON_IDS_OTHER_DOCUMENT_PHOTO", "PERSON_INFO_GENDER", "PERSON_INFO_NATIONALITY", "PERSON_INFO_BIRTHDATE", "PERSON_INFO_BIRTH_CITY", "PERSON_INFO_BIRTH_COUNTRY", "PERSON_INFO_AGE", "PERSON_INFO_FOREIGNER_STATUS", "COMPANY_NAME_NAME", "COMPANY_IDS_TAX_ID", "PERSON_ADDRESS", "COMPANY_ADDRESS", "PERSON_CONTACT_EMAIL", "PERSON_CONTACT_PHONE", "PERSON_CONTACT_EMAIL_OTP", "PERSON_CONTACT_PHONE_OTP", "COMPANY_CONTACT_EMAIL", "COMPANY_CONTACT_PHONE", "COMPANY_IDS_ADDITIONAL_ID", "COMPANY_IDS_ACCOUNTS" ], "readOnly": true }, "reliability": { "type": "number", "format": "double", "description": "Information about how closely the field matches the input data", "maximum": 1, "minimum": 0, "readOnly": true } }, "required": ["field", "reliability"] }, "BadRequestApiError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "Violation": { "type": "object", "properties": { "field": { "type": "string", "description": "Field name" }, "message": { "type": "string", "description": "Descriptive error message" } }, "required": ["field", "message"] }, "MethodArgumentNotValidError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "MethodArgumentTypeMismatchError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "ConstraintViolationError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "CustomValidationApiError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "OperationNotSupportedApiFieldError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "MissingHeaderApiError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "ApiError": { "type": "object", "properties": { "status": { "type": "string", "description": "Response status" }, "message": { "type": "string", "description": "Descriptive error message" }, "violations": { "type": "array", "description": "Validation error list", "items": { "$ref": "#/components/schemas/Violation" } }, "statusDetail": { "type": "string", "description": "Response status detailed information" } }, "required": ["message", "status", "violations"] }, "HeadlessNextPageRequest": { "type": "object", "description": "Map of parameters sent by the user", "properties": { "args": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HeadlessPage": { "type": "object", "description": "Page definition which should be rendered to the user", "properties": { "component": { "type": "string", "description": "Information needed to render the page" }, "next": { "type": "string", "description": "Id of the page to which the user information should be submitted" }, "args": { "type": "object", "additionalProperties": {}, "description": "Option parameters which can be used by the user" }, "errors": { "type": "array", "description": "Information about errors occurred when processing the data from the page", "items": { "$ref": "#/components/schemas/HeadlessPageArgError" } } } }, "HeadlessPageArgError": { "type": "object", "properties": { "field": { "type": "string" }, "code": { "type": "string" } }, "required": ["code", "field"] }, "IdentityMetadata": { "type": "object", "description": "Information about the metadata collected during the identification process", "properties": { "id": { "type": "string", "description": "Conversation Id", "example": "e0c0b3cc-8238-414f-9940-9f14bd1b8693b" }, "list": { "$ref": "#/components/schemas/MetadataInfo", "description": "Metadata list, collected during the identification process" } }, "required": ["id", "list"] }, "Media": { "type": "object", "description": "Information about media file", "properties": { "id": { "type": "string", "description": "Media id", "example": "c9c73416-6f77-11eb-b60f-0240214a8d4b" }, "type": { "type": "string", "description": "Media type:\n* DOCUMENT - identified person's document\n* FACE - identified person's face\n* REPORT - verification process report\n ", "enum": ["DOCUMENT", "FACE", "REPORT"], "example": "DOCUMENT" }, "subtype": { "type": "string", "description": "Media subtype, for example type of the document. Subtype is empty, if the type is FACE.:\n* ID_CARD - identified person's id card\n* DRIVER_LICENSE - identified person's driver license\n* PASSPORT - identified person's passport\n* RESIDENCE_PERMIT - identified person's residence permit\n* UTILITY_BILL - identified person's proof of address\n ", "enum": ["ID_CARD", "DRIVER_LICENSE", "PASSPORT", "RESIDENCE_PERMIT", "UTILITY_BILL"], "example": "ID_CARD" }, "variant": { "type": "string", "description": "Media variant, for example side of the document. Variant is empty, if the type is FACE.:\n* FRONT - front side of the document\n* BACK - back side of the document\n ", "enum": ["FRONT", "BACK"], "example": "BACK" }, "contentType": { "type": "string", "description": "Media content type", "example": "image/png" } }, "required": ["contentType", "id", "type"] }, "MetadataInfo": { "type": "object", "description": "Information about the list of available metadata collected during the identification process", "properties": { "media": { "type": "array", "description": "List of available media files", "items": { "$ref": "#/components/schemas/Media" } } }, "required": ["media"] }, "Transaction": { "type": "object", "description": "Information about the transaction", "properties": { "id": { "type": "string", "description": "Unique identifier for the transaction", "example": "34df2bd6-b790-4560-9fc9-f86c86d87990" }, "date": { "type": "string", "format": "date-time", "description": "Transaction date", "example": "2020-09-24T08:27:14.515Z" }, "bank": { "type": "string", "description": "Bank's SWIFT / BIC code", "example": "BREXPLPW" }, "accountId": { "type": "string", "description": "Account number where transaction was registered.", "example": "PL68249000050000400075212326" }, "type": { "type": "string", "description": "Transaction Type / Direction:\n* CREDIT - account crediting\n* DEBIT - debiting the account\n ", "enum": ["CREDIT", "DEBIT"], "example": "CREDIT" }, "status": { "type": "string", "description": "Transaction status:\n* BOOKED - transaction booked\n* PENDING - transaction in progress\n* SCHEDULED - Transaction scheduled in the future\n ", "enum": ["BOOKED", "PENDING", "SCHEDULED"], "example": "BOOKED" }, "amount": { "type": "integer", "format": "int32", "description": "Transaction value in basic units - e.g. in cents", "example": 10030 }, "currency": { "type": "string", "description": "Currency code in which the transaction took place", "example": "PLN" }, "title": { "type": "string", "description": "Transaction title", "example": "Zasilenie konta" }, "sender": { "type": "string", "description": "Information about the sender", "example": "Jan Kowalski" }, "recipient": { "type": "string", "description": "Information about the recipient", "example": "Jan Kowalski" }, "senderAccountId": { "type": "string", "description": "Account number of the sender", "example": "PL68249000050000400075212326" }, "recipientAccountId": { "type": "string", "description": "Account number of the receiver", "example": "PL32114020040000320250132522" }, "tags": { "type": "array", "description": "Transaction categories", "example": [ "income:salary", "income:bonus", "income:freelance:contract", "income:freelance:b2b", "income:rental", "income:invoicing", "income:pension", "gambling", "income:bond" ], "items": { "type": "string" }, "uniqueItems": true } }, "required": ["accountId", "amount", "bank", "currency", "date", "id", "status", "type"] }, "Transactions": { "type": "object", "properties": { "more": { "type": "boolean", "description": "Information whether there are more pages available", "example": true }, "items": { "type": "array", "description": "List of transactions", "items": { "$ref": "#/components/schemas/Transaction" } } }, "required": ["items", "more"], "title": "Transactions" }, "TransactionStatistics": { "type": "object", "description": "Information about transaction statistics for a given account", "properties": { "dateFirst": { "type": "string", "format": "date-time", "description": "Date of the first transaction in the range", "example": "2020-07-24T08:00:00Z" }, "dateLast": { "type": "string", "format": "date-time", "description": "Date of the last transaction in the range", "example": "2020-08-30T00:00:00Z" }, "numberOfCreditTransactions": { "type": "integer", "format": "int32", "description": "The number of credit transactions of the account. The value will be available if you selected all transactions or credit transactions.", "example": 12 }, "numberOfDebitTransactions": { "type": "integer", "format": "int32", "description": "Number of account debit transactions. The value will be available if you selected all transactions or debit transactions.", "example": 2 }, "avgCreditPerMonth": { "type": "integer", "format": "int32", "description": "Average value of credit transactions per month, presented in basic units - e.g. in cents. The value will be available if the analyzed period is greater than 60 days and if credit transactions or all of them were selected when creating the conversation.", "example": 300000 }, "avgDebitPerMonth": { "type": "integer", "format": "int32", "description": "Average value of credit transactions per month, presented in basic units - e.g. in cents. The value will be available if the analyzed period is greater than 60 days and if credit transactions or all of them were selected when creating the conversation.", "example": 258000 }, "avgCredit": { "type": "integer", "format": "int32", "description": "Average value of the account's credit transactions, presented in basic units - e.g. in cents. The value will be available if you selected all transactions or credit transactions.", "example": 30000 }, "avgDebit": { "type": "integer", "format": "int32", "description": "Average value of the account's debit transactions, presented in basic units - e.g. in cents. The value will be available if you selected all transactions or debit transactions.", "example": 40000 }, "maxCredit": { "type": "integer", "format": "int32", "description": "Maximum value of the account credit transaction, presented in basic units - e.g. in cents. The value will be available if you selected or all credit transactions when creating the conversation.", "example": 110000 }, "maxDebit": { "type": "integer", "format": "int32", "description": "Maximum value of the account debit transaction, presented in basic units - e.g. in cents. The value will be available if you selected all transactions or debit transactions.", "example": 132000 }, "accountId": { "type": "string", "description": "Account number.", "example": "PL68249000050000400075212326" }, "currency": { "type": "string", "description": "Currency code for the account", "example": "PLN" } }, "required": ["accountId", "currency", "dateFirst", "dateLast"] }, "TransactionsStatistics": { "type": "object", "properties": { "dateFrom": { "type": "string", "format": "date-time", "description": "The starting date of the search criteria or the date of the first transaction for all accounts if the criteria was empty", "example": "2020-07-24T08:00:00Z" }, "dateTo": { "type": "string", "format": "date-time", "description": "End date of the search criteria or the last transaction date for all accounts if the criteria was empty", "example": "2020-08-24T00:00:00Z" }, "items": { "type": "array", "description": "List of transaction statistics for each account separately", "items": { "$ref": "#/components/schemas/TransactionStatistics" } } }, "required": ["items"], "title": "TransactionsStatistics" }, "Account": { "type": "object", "description": "Information about transactions for a given account", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date for which the data is valid", "example": "2020-09-24T08:27:14.515Z" }, "balance": { "type": "integer", "format": "int32", "description": "Account balance in basic units - e.g. in cents", "example": 10030 }, "bank": { "type": "string", "description": "Bank's SWIFT / BIC code", "example": "BREXPLPW" }, "accountId": { "type": "string", "description": "Unique account identifier. All transactions from one account have the same ID", "example": "PL68249000050000400075212326" }, "currency": { "type": "string", "description": "Currency code for the account", "example": "PLN" }, "activationDate": { "type": "string", "format": "date", "description": "The date when the account was opened or the date of the oldest transaction found", "example": "2020-09-24" } }, "required": ["accountId", "bank", "currency", "date"] }, "Accounts": { "type": "object", "properties": { "items": { "type": "array", "description": "List of transaction information for each account", "items": { "$ref": "#/components/schemas/Account" } } }, "required": ["items"], "title": "TransactionsInfo" }, "AMLInfo": { "type": "object", "properties": { "more": { "type": "boolean", "description": "Information whether there are more pages available", "example": true }, "items": { "type": "array", "description": "List of information collected during AML verification", "items": { "oneOf": [ { "$ref": "#/components/schemas/AMLMediaInfo" }, { "$ref": "#/components/schemas/AMLOtherInfo" }, { "$ref": "#/components/schemas/AMLPepInfo" }, { "$ref": "#/components/schemas/AMLSanctionsInfo" }, { "$ref": "#/components/schemas/AMLSipInfo" } ] } } }, "required": ["items", "more"], "title": "AMLInfo" }, "AMLInfoEntry": { "description": "Provides AML information types", "discriminator": { "propertyName": "entryType" }, "properties": { "entryType": { "type": "string" } }, "required": ["entryType"] }, "AMLMediaInfo": { "allOf": [ { "$ref": "#/components/schemas/AMLInfoEntry" }, { "type": "object", "properties": { "originalUrl": { "type": "string", "description": "Link to adverse article", "example": "https://secure.c6-intelligence.com/c6images/ari0202017/A7JElyvSi.pdf" }, "date": { "type": "string", "format": "date", "description": "Adverse Media publication date or capture date", "example": "2014-03-27" }, "url": { "type": "string", "description": "Link to PDF with original adverse media publication", "example": "http://kremlin.ru/structure/security-council/members" }, "categories": { "type": "array", "description": "Media categorization", "example": ["PEP"], "items": { "type": "string" } } } } ], "description": "Adverse Media information type" }, "AMLOtherInfo": { "allOf": [ { "$ref": "#/components/schemas/AMLInfoEntry" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Informs if entry describes person or person's relative:\n* PERSON - person\n* RCA - person's relative\n ", "enum": ["PERSON", "RCA"], "example": "PERSON" }, "score": { "type": "number", "format": "double", "description": "Percent compliance of provided personal data with results (0-1 if provided or null)", "example": 0.98 }, "reason": { "type": "string", "description": "Reason why person is on the list", "example": "EO14024 PROGRAM" }, "user": { "$ref": "#/components/schemas/AMLOtherUserInfo", "description": "Data found on AML lists for provided person" } } } ], "description": "Individuals with other AML categories implemented e.g. POI, TER, etc.", "required": ["type", "user"] }, "AMLOtherPersonInfo": { "type": "object", "properties": { "gender": { "type": "string", "description": "The gender of the user (MALE/FEMALE/OTHER)", "enum": ["MALE", "FEMALE", "OTHER"], "example": "MALE" }, "nationality": { "type": "string", "description": "User's nationality", "example": "Poland" }, "birthDate": { "type": "string", "description": "Date of birth", "example": 1972 }, "deceased": { "type": "boolean", "description": "Information if person is dead", "example": true }, "deceaseDate": { "type": "string", "description": "Date of death", "example": 2012 }, "image": { "type": "string", "description": "URL to person's picture", "example": "http://....." }, "roles": { "type": "array", "description": "Information about the position held by the person", "items": { "$ref": "#/components/schemas/AMLOtherPersonRole" } } } }, "AMLOtherPersonName": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "middleName": { "type": "string", "description": "Second name", "example": "Stanisław" }, "spellings": { "type": "array", "description": "Correct spelling of name and surname, including in national language", "example": [], "items": { "type": "string" } }, "alsoKnownAs": { "type": "array", "description": "Alias names of person under verification", "items": { "$ref": "#/components/schemas/AmlOtherAlsoKnowAs" } } }, "required": ["alsoKnownAs", "spellings"] }, "AMLOtherPersonRole": { "type": "object", "properties": { "title": { "type": "string", "description": "Position held", "example": "Former Acting President" }, "country": { "type": "string", "description": "The country in which the position was held", "example": "Poland" }, "fromDate": { "type": "string", "description": "Start date of tenure", "example": "2000-05" }, "tillDate": { "type": "string", "description": "End date of tenure", "example": 2005 } }, "required": ["country", "title"] }, "AMLOtherPersonUserInfo": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/AMLOtherPersonName", "description": "Personal data of a person under verification" }, "info": { "$ref": "#/components/schemas/AMLOtherPersonInfo", "description": "Additional information about the person under verification" } } }, "AMLOtherUserInfo": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/AMLOtherPersonUserInfo", "description": "Contains user-related data asociating user as Special Interest Person" } } }, "AMLPepAddressInfo": { "type": "object", "properties": { "country": { "type": "string", "description": "Country name for person", "example": "Poland" } }, "required": ["country"] }, "AMLPepInfo": { "allOf": [ { "$ref": "#/components/schemas/AMLInfoEntry" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Informs if entry describes person or person's relative:\n* PERSON - person\n* RCA - person's relative\n ", "enum": ["PERSON", "RCA"], "example": "PERSON" }, "score": { "type": "number", "format": "double", "description": "Compliance level of provided personal data with results (0-1 if provided or null)", "example": 0.98 }, "reason": { "type": "string", "description": "Reason why person is on the list", "example": "EUROPEAN UNION: PARLIAMENT (EX)" }, "user": { "$ref": "#/components/schemas/AMLPepUserInfo", "description": "Data found on AML lists for provided person" } } } ], "description": "Politically Exposed Person information type", "required": ["type", "user"] }, "AMLPepPersonInfo": { "type": "object", "properties": { "gender": { "type": "string", "description": "The gender of the user (MALE/FEMALE/OTHER)", "enum": ["MALE", "FEMALE", "OTHER"], "example": "MALE" }, "nationality": { "type": "string", "description": "User's nationality", "example": "Poland" }, "birthDate": { "type": "string", "description": "Date of birth", "example": 1972 }, "deceased": { "type": "boolean", "description": "Information if person is dead", "example": true }, "deceasedDate": { "type": "string", "description": "Date of death", "example": 2012 }, "image": { "type": "string", "description": "URL to person's picture", "example": "http://....." }, "roles": { "type": "array", "description": "Information about the exposed position held by the person", "items": { "$ref": "#/components/schemas/AMLPepPersonRole" } } } }, "AMLPepPersonName": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "middleName": { "type": "string", "description": "Second name", "example": "Stanisław" }, "spellings": { "type": "array", "description": "Correct spelling of name and surname (including national language)", "example": [], "items": { "type": "string" } }, "alsoKnownAs": { "type": "array", "description": "Alias names of person under verification", "items": { "$ref": "#/components/schemas/AmlPepAlsoKnowAs" } } }, "required": ["alsoKnownAs", "spellings"] }, "AMLPepPersonRole": { "type": "object", "properties": { "title": { "type": "string", "description": "Position held", "example": "Former Acting President" }, "country": { "type": "string", "description": "The country in which the position was held", "example": "Poland" }, "fromDate": { "type": "string", "description": "Start date of tenure", "example": "2000-05" }, "tillDate": { "type": "string", "description": "End date of tenure", "example": 2005 } }, "required": ["country", "title"] }, "AMLPepPersonUserInfo": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/AMLPepPersonName", "description": "Personal data of a person under verification" }, "info": { "$ref": "#/components/schemas/AMLPepPersonInfo", "description": "Additional information about the person under verification" }, "address": { "$ref": "#/components/schemas/AMLPepAddressInfo", "description": "Address information of the person under verification" } } }, "AMLPepUserInfo": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/AMLPepPersonUserInfo", "description": "User-related data found on AML PEP verification list" } } }, "AMLSanctionsAddressInfo": { "type": "object", "properties": { "country": { "type": "string", "description": "Country name for person", "example": "Poland" } }, "required": ["country"] }, "AMLSanctionsInfo": { "allOf": [ { "$ref": "#/components/schemas/AMLInfoEntry" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Informs if entry describes person or person's relative:\n* PERSON - person\n* RCA - person's relative\n ", "enum": ["PERSON", "RCA"], "example": "PERSON" }, "score": { "type": "number", "format": "double", "description": "Percent compliance of provided personal data with results (0-1 if provided or null)", "example": 0.98 }, "reason": { "type": "string", "description": "Reason why person is on the list", "example": "EO14024 PROGRAM" }, "sources": { "type": "array", "description": "Names of AML list types on which the person was found", "example": ["OFAC", "EU"], "items": { "type": "string" } }, "user": { "$ref": "#/components/schemas/AMLSanctionsUserInfo", "description": "Data found on AML lists for provided person" } } } ], "description": "Sanctions information type", "required": ["sources", "type", "user"] }, "AMLSanctionsPersonInfo": { "type": "object", "properties": { "gender": { "type": "string", "description": "The gender of the user (MALE/FEMALE/OTHER)", "enum": ["MALE", "FEMALE", "OTHER"], "example": "MALE" }, "nationality": { "type": "string", "description": "User's nationality", "example": "Poland" }, "birthDate": { "type": "string", "description": "Date of birth", "example": 1972 }, "deceased": { "type": "boolean", "description": "Information if person is dead", "example": true }, "deceaseDate": { "type": "string", "description": "Date of death", "example": 2012 }, "image": { "type": "string", "description": "URL to person's picture", "example": "http://....." }, "roles": { "type": "array", "description": "Information about the position held by the person", "items": { "$ref": "#/components/schemas/AMLSanctionsPersonRole" } } } }, "AMLSanctionsPersonName": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "middleName": { "type": "string", "description": "Second name", "example": "Stanisław" }, "spellings": { "type": "array", "description": "Correct spelling of name and surname, including in national language", "example": [], "items": { "type": "string" } }, "alsoKnownAs": { "type": "array", "description": "Alias names of person under verification", "items": { "$ref": "#/components/schemas/AmlSanctionsAlsoKnowAs" } } }, "required": ["alsoKnownAs", "spellings"] }, "AMLSanctionsPersonRole": { "type": "object", "properties": { "title": { "type": "string", "description": "Position held", "example": "Former Acting President" }, "country": { "type": "string", "description": "The country in which the position was held", "example": "Poland" }, "fromDate": { "type": "string", "description": "Start date of tenure", "example": "2000-05" }, "tillDate": { "type": "string", "description": "End date of tenure", "example": 2005 } }, "required": ["country", "title"] }, "AMLSanctionsPersonUserInfo": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/AMLSanctionsPersonName", "description": "Personal data of a person under verification" }, "info": { "$ref": "#/components/schemas/AMLSanctionsPersonInfo", "description": "Additional information about the person under verification" }, "address": { "$ref": "#/components/schemas/AMLSanctionsAddressInfo", "description": "Address information of the person under verification" } } }, "AMLSanctionsUserInfo": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/AMLSanctionsPersonUserInfo", "description": "Contains user-related data found on AML SANCTIONS verification list" } } }, "AMLSipInfo": { "allOf": [ { "$ref": "#/components/schemas/AMLInfoEntry" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Informs if entry describes person or person's relative:\n* PERSON - person\n* RCA - person's relative\n ", "enum": ["PERSON", "RCA"], "example": "PERSON" }, "score": { "type": "number", "format": "double", "description": "Percent compliance of provided personal data with results (0-1 if provided or null)", "example": 0.98 }, "reason": { "type": "string", "description": "Reason why person is on the list", "example": "EO14024 PROGRAM" }, "user": { "$ref": "#/components/schemas/AMLSipUserInfo", "description": "Data found on AML lists for provided person" } } } ], "description": "Special Interest Person information type", "required": ["type", "user"] }, "AMLSipPersonInfo": { "type": "object", "properties": { "gender": { "type": "string", "description": "The gender of the user (MALE/FEMALE/OTHER)", "enum": ["MALE", "FEMALE", "OTHER"], "example": "MALE" }, "nationality": { "type": "string", "description": "User's nationality", "example": "Poland" }, "birthDate": { "type": "string", "description": "Date of birth", "example": 1972 }, "deceased": { "type": "boolean", "description": "Information if person is dead", "example": true }, "deceaseDate": { "type": "string", "description": "Date of death", "example": 2012 }, "image": { "type": "string", "description": "URL to person's picture", "example": "http://....." }, "roles": { "type": "array", "description": "Information about the position held by the person", "items": { "$ref": "#/components/schemas/AMLSipPersonRole" } } } }, "AMLSipPersonName": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "middleName": { "type": "string", "description": "Second name", "example": "Stanisław" }, "spellings": { "type": "array", "description": "Correct spelling of name and surname, including in national language", "example": [], "items": { "type": "string" } }, "alsoKnownAs": { "type": "array", "description": "Alias names of person under verification", "items": { "$ref": "#/components/schemas/AmlSipAlsoKnowAs" } } }, "required": ["alsoKnownAs", "spellings"] }, "AMLSipPersonRole": { "type": "object", "properties": { "title": { "type": "string", "description": "Position held", "example": "Former Acting President" }, "country": { "type": "string", "description": "The country in which the position was held", "example": "Poland" }, "fromDate": { "type": "string", "description": "Start date of tenure", "example": "2000-05" }, "tillDate": { "type": "string", "description": "End date of tenure", "example": 2005 } }, "required": ["country", "title"] }, "AMLSipPersonUserInfo": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/AMLSipPersonName", "description": "Personal data of a person under verification" }, "info": { "$ref": "#/components/schemas/AMLSipPersonInfo", "description": "Additional information about the person under verification" } } }, "AMLSipUserInfo": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/AMLSipPersonUserInfo", "description": "Contains user-related data asociating user as Special Interest Person" } } }, "AmlOtherAlsoKnowAs": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "title": { "type": "string", "description": "User alias", "example": "Known As" } } }, "AmlPepAlsoKnowAs": { "type": "object", "properties": { "firstName": { "type": "string", "description": "Alias user name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "title": { "type": "string", "description": "User alias", "example": "Known As" } } }, "AmlSanctionsAlsoKnowAs": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "title": { "type": "string", "description": "User alias", "example": "Known As" } } }, "AmlSipAlsoKnowAs": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "title": { "type": "string", "description": "User alias", "example": "Known As" } } }, "Affordability": { "type": "object", "properties": { "items": { "type": "array", "description": "List of affordability assessment results", "items": { "$ref": "#/components/schemas/AffordabilityResultDetails" } } }, "required": ["items"], "title": "Affordability" }, "AffordabilityAccount": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number", "example": "PL12345678901234567890123456" }, "bankName": { "type": "string", "description": "Account issueDate", "example": "Bank Millennium" }, "accountType": { "type": "string", "description": "Account type/name", "example": "Current" }, "balance": { "type": "number", "format": "double", "description": "Balance", "example": 15450.75 }, "overdraft": { "type": "string", "description": "Account has an overdraft", "example": false }, "openingDate": { "type": "string", "format": "date", "description": "Account opening date", "example": "2010-11-09" }, "currency": { "type": "string", "description": "Currency", "example": "EUR" } }, "title": "AffordabilityAccount" }, "AffordabilityAccountInformation": { "type": "object", "properties": { "account": { "type": "array", "description": "List of account information", "items": { "$ref": "#/components/schemas/AffordabilityAccount" } } }, "required": ["account"], "title": "AffordabilityAccountInformation" }, "AffordabilityAddress": { "type": "object", "properties": { "text": { "type": "string", "description": "User's full address, not broken down into components. **Note:** This field has no format defined", "example": "ul. Wolna 133/20 00-950 Warszawa" }, "addressLine": { "type": "string", "description": "User address", "example": "ul. Wolna 133/20" }, "postalCode": { "type": "string", "description": "Postcode", "example": "00-950" }, "city": { "type": "string", "description": "City", "example": "Warszawa" }, "country": { "type": "string", "description": "Country", "example": "PL" } }, "title": "AffordabilityAddressInfo" }, "AffordabilityCurrencyConversion": { "type": "object", "properties": { "convertedAmount": { "type": "number", "format": "double", "description": "Net income after conversion to target currency", "example": 4766.9472 }, "targetCurrency": { "type": "string", "description": "Target currency", "example": "USD" }, "exchangeRate": { "type": "number", "format": "double", "description": "Exchange rate applied by provider", "example": 1.177024 } }, "title": "AffordabilityCurrencyConversion" }, "AffordabilityDocumentInformation": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the collected document", "example": "EmploymentContract" }, "number": { "type": "string", "description": "Number of the collected document", "example": "TS/KOW/2022/11" }, "issueDate": { "type": "string", "format": "date", "description": "Document issue date", "example": "2022-11-01" }, "confidenceScore": { "type": "string", "description": "Level of trust of the analysed document", "example": 0.95 }, "trustScore": { "type": "number", "format": "double", "description": "Document Trust Index score (0-1, one decimal)", "example": 0.7 }, "periodStart": { "type": "string", "format": "date", "description": "Period start date that analysed document refers to", "example": "2023-01-01" }, "periodEnd": { "type": "string", "format": "date", "description": "Period end date that analysed document refers to", "example": "2023-12-31" } }, "title": "AffordabilityDocumentInformation" }, "AffordabilityFinancialAnalysisInformation": { "type": "object", "properties": { "income": { "type": "number", "format": "double", "description": "Summary income" }, "expenditure": { "type": "number", "format": "double", "description": "Summary expenditure" }, "currency": { "type": "string", "description": "Currency", "example": "EUR" } }, "title": "AffordabilityFinancialAnalysisInformation" }, "AffordabilityPersonalInformation": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User name", "example": "Jan" }, "lastName": { "type": "string", "description": "User surname", "example": "Kowalski" }, "fullName": { "type": "string", "description": "Full surname", "example": "Jan Kowalski" }, "birthDate": { "type": "string", "format": "date", "description": "Date of birth" }, "address": { "$ref": "#/components/schemas/AffordabilityAddress", "description": "Representation of address collected in affordability assessment validation process" } }, "title": "AffordabilityPersonalInformation" }, "AffordabilityResultDetails": { "type": "object", "properties": { "personalInformation": { "$ref": "#/components/schemas/AffordabilityPersonalInformation", "description": "Representation of the personal data collected in affordability assessment validation process" }, "accountInformation": { "$ref": "#/components/schemas/AffordabilityAccountInformation", "description": "Representation of the data related with account collected in affordability assessment validation process" }, "sourceOfFundsInformation": { "$ref": "#/components/schemas/AffordabilitySourceOfFundsInformation", "description": "Representation of the data related with source of funds information collected in affordability assessment validation process" }, "documentInformation": { "$ref": "#/components/schemas/AffordabilityDocumentInformation", "description": "Representation of the data related with document collected in affordability assessment validation process" }, "financialAnalysis": { "$ref": "#/components/schemas/AffordabilityFinancialAnalysisInformation", "description": "Summary of affordability assessment validation" } }, "title": "AffordabilityResult" }, "AffordabilitySourceOfFunds": { "type": "object", "properties": { "type": { "type": "string", "description": "Source type", "example": "Employment" }, "name": { "type": "string", "description": "Name of the institution being the source of funds", "example": "Tech Solutions sp. z o.o." }, "grossAmount": { "type": "number", "format": "double", "description": "Contract gross amount", "example": 8500 }, "netAmount": { "type": "number", "format": "double", "description": "Contract net amount", "example": 6120.5 }, "currencyConversion": { "$ref": "#/components/schemas/AffordabilityCurrencyConversion", "description": "Net income conversion metadata" }, "currency": { "type": "string", "description": "Currency", "example": "EUR" }, "frequency": { "type": "string", "description": "Payment frequency", "example": "Monthly" }, "contractType": { "type": "string", "description": "Type of the contract", "example": "Permanent" }, "contractEndDate": { "type": "string", "format": "date", "description": "Contract end date", "example": "2099-12-31" }, "partTimePercentage": { "type": "number", "format": "double", "description": "Part of a full-time position covered by the agreement", "example": 1 } }, "title": "AffordabilitySourceOfFunds" }, "AffordabilitySourceOfFundsInformation": { "type": "object", "properties": { "sourceOfFunds": { "type": "array", "description": "List of sources of funds related to affordability results", "items": { "$ref": "#/components/schemas/AffordabilitySourceOfFunds" } } }, "required": ["sourceOfFunds"], "title": "AffordabilitySourceOfFundsInformation" } }, "securitySchemes": { "apiKey": { "type": "http", "description": "To log in, use the user's login and password. The password is the API key obtained for a specific environment. You can generate a new key in the API Keys section of the OmniPanel.", "scheme": "basic" }, "oauth2": { "type": "oauth2", "description": " To log in, use the user's login and password for client_id and client_secret, respectively. The password is the API key obtained for a specific environment. You can generate a new key in the API Keys section of the OmniPanel.\n \n Here is an example curl command for getting an access token:\n\n```bash\ncurl -i -X POST 'https://ENVIRONMENT_URL/api/oauth2/token' --header 'Authorization: Basic base64(user:pass)' --header 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials'\n```\n\n**Note the following:**\n- use HTTP POST method while making the call\n- set the Content-Type header to application/x-www-form-urlencoded\n- pass in OAuth flow information: grant_type=client_credentials\n Once the token has been received, it should be stored somewhere and can be used while making regular api calls.\n The OAuth calls should set the Authorization header as follows:\n \n ```http\nAuthorization: Bearer \n```\n ", "scheme": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://sandbox.authologic.com/api/oauth2/token", "scopes": {} } } } } } }