{"openapi":"3.0.3","info":{"title":"Generated API","description":"API","version":"1.0.0"},"servers":[{"url":"https://external-api.identomat.com"}],"paths":{"/list-session-activities":{"post":{"summary":"List of session activities","description":"This endpoint retrieves a list of activities related to a specific session.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-session-activities"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-session-activities-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"session-not-found"}}]}}}}}}},"/get-session-main-document-face-photo":{"post":{"summary":"Get face photo from main document","description":"This endpoint allows you to retrieve the face photo from the main document associated with a specific session.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-session-main-document-face-photo"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-session-main-document-face-photo-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"face-photo-not-found"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"session-not-found"}}]}}}}}}},"/get-session-statistical-summary":{"post":{"summary":"Session statistical summery","description":"This endpoint retrieves a statistical summary of a session, providing key metrics and insights.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-session-statistical-summary"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-session-statistical-summary-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/search-screening-person":{"post":{"summary":"Search for a person in screening databases","description":"\r\nUse this endpoint to search for individuals in global screening databases including sanctions, PEPs (Politically Exposed Persons), regulatory actions, and more.\r\n\r\n**Parameters:**\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `query` _(object, required)_ – The parameters for querying the database.\r\n    -   `fullName` _(string, required)_ – Full name of the individual.\r\n    -   `birthdayTimeFrom` _(string, optional)_ – The start date and time of the birthday range in ISO 8601 format.\r\n    -   `scoreThreshold` _(integer, required)_ – The minimum score required for the query results.\r\n-   `offset` _(integer, optional)_ – The number of items to skip from the beginning of the results.\r\n-   `limit` _(integer, optional)_ – The maximum number of items to return in the query results.\r\n    \r\n\r\n**Entities glossary:**\r\n-   `**Sanctioned Entity**`: Companies, individuals, or other entities that have been designated by a government to prohibit specific interactions with them.\r\n-   `**Sanction-linked Entity**`: Entities, including companies and individuals, that have a direct relationship with a sanctioned entity. This also includes companies that are indirect subsidiaries of sanctioned entities, regardless of the percentage ownership held by the sanctioned entity.\r\n-   `**Counter-sanctioned Entity**`: Entities listed on sanctions lists from non-democratic countries, often targeting pro-democracy activists, journalists, and human rights advocates.\r\n-   `**Debarred Entity**`: Companies or individuals that have been excluded from public procurement, typically due to committing fraud in the execution of a government contract.\r\n-   `**Politician (Politically Exposed Persons)**`: Individuals who currently or previously held a position of political influence.\r\n-   `**Close Associate**`: Family members and key business associates of politically exposed persons (PEPs). These individuals are often used as nominees or front-people to hide illicit financial gains.\r\n-   `**Person of Interest**`: Individuals under scrutiny due to public interest, who do not meet the common definitions of politically-exposed persons and are not sanctioned.\r\n-   `**Regulator Action**`: Companies that have been subject to enforcement action by an industry regulatory body.\r\n-   `**Regulator Warning**`: Companies that have been placed on a warning or alert list by an industry regulatory body.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-screening-person"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-screening-person-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"company-missing"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"access-denied"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"payment-needed"}}]}}}}}}},"/get-screening-person-details":{"post":{"summary":"Get person details from screening databases","description":"Retrieve extended profile data, positions, aliases, sanctions, and other metadata for a specific individual listed in screening databases.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `personId` _(string, required)_ – The unique identifier for the person.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-screening-person-details"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-screening-person-details-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"payment-needed"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"company-missing"}}]}}}}}}},"/get-video-call-shots":{"post":{"summary":"Get video call screenshots","description":"Retrieves all screenshots (shots) taken by the operator during a video call session. These images serve as part of the evidence captured during the KYC verification.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-video-call-shots"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-video-call-shots-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"not-found"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/remove-screening-query-from-monitoring":{"post":{"summary":"Remove person from monitoring","description":"Removes an individual from ongoing screening monitoring, unsubscribing from further updates or alerts related to that person.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `id` _(string, required)_ - The ID of monitoring query.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/remove-screening-query-from-monitoring"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/remove-screening-query-from-monitoring-response"}}}}}}},"/list-screening-monitoring-records":{"post":{"summary":"List screening records that are monitored","description":"Retrieves a list of individuals currently being monitored for screening. This includes basic metadata like name, ID, and optionally the last updated date.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `start` _(integer, optional)_ – The number of items to skip from the beginning of the results.\r\n-   `limit` _(integer, optional)_ – The maximum number of records to return.\r\n-   `date` _(string, optional, ISO 8601 format)_ – Filters records after a specific date. If no date is provided, the entire list will be returned.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-screening-monitoring-records"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-screening-monitoring-records-response"}}}}}}},"/monitor-screening-query":{"post":{"summary":"Set person on monitoring","description":"Enable ongoing monitoring of a specific individual in screening databases. If the person is already on monitoring, an appropriate error will be returned.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `query` _(object, required)_ – The parameters for querying the database.\r\n    -   `fullName` _(string, required)_ – The last name of the individual.\r\n    -   `birthdayTimeFrom` _(string, optional)_ – The start date and time of the birthday range in ISO 8601 format.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor-screening-query"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor-screening-query-response"}}}}}}},"/export-session-as-pdf":{"post":{"summary":"Export session","description":"This endpoint allows you to export data related to a specific session as a downloadable PDF document. You can choose to include the full session details, screening results, and/or proof of address documents. At least one export option must be set to `true`.\r\n\r\n**Parameters:**\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.\r\n\r\nOne of the following parameters must be set to `true` for the operation to proceed:\r\n-   `exportSession` _(boolean, optional)_ – Indicates whether to export the full session data.\r\n-   `exportScreening` _(boolean, optional)_ – Specifies whether to include screening results in the export.\r\n-   `exportProofOfAddress` _(boolean, optional)_ - Determines whether to include proof of address documents in the export.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/export-session-as-pdf"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/export-session-as-pdf-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"wrong-parameters"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"session-not-found"}}]}}}}}}},"/get-video-call-videos":{"post":{"summary":"Get video call videos","description":"Retrieves all video recordings from the video call session. These are typically used for compliance, auditing, or further verification purposes.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-video-call-videos"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-video-call-videos-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"not-found"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/list-groups":{"post":{"summary":"List groups","description":"Retrieves a list of groups associated with the specified company. Each group includes its ID, name, description, and a list of its members.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-groups"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-groups-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"groups-not-found"}}]}}}}}}},"/list-users":{"post":{"summary":"List users","description":"This endpoint retrieves a list of users associated with the company.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-users"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-users-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/get-session-config":{"post":{"summary":"Get session configuration","description":"This endpoint retrieves the configuration details for a specific session configuration based on the given session config ID.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionConfigId` _(string, required)_ – The unique identifier for the session configuration.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-session-config"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-session-config-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"wrong-parameters"}}]}}}}}}},"/change-group":{"post":{"summary":"Update existing group","description":"Allows you to modify an existing group by updating its name, description, or changing the members in the group. **To keep existing members in the group, you must include their IDs in the list.**\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `groupId` _(string, required)_ – The unique identifier of the group.\r\n-   `name` _(string, optional)_ – The name of the new group.\r\n-   `description` _(string, optional)_ – A description for the group.\r\n-   `memberIds` _(array of strings, optional)_ – A list of user IDs to be added or removed from the group. To keep existing members in the group, you must include their IDs in the list.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/change-group"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/change-group-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{},"example":{}},{"type":"object","properties":{},"example":{}},{"type":"object","properties":{},"example":{}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/delete-group":{"post":{"summary":"Delete a group","description":"Allows you to delete a group permanently from the system.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `groupId` _(string, required)_ – The unique identifier of the group.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-group"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-group-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/make-group":{"post":{"summary":"Create a new group","description":"Creates a new user group under the specified company. A group can be used to manage permissions, assign sessions, or organize users.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `name` _(string, required)_ – The name of the new group.\r\n-   `memberIds` _(array of strings, optional)_ – A list of user IDs to be added to the group.\r\n-   `description` _(string, optional)_ – A description of the new group.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/make-group"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/make-group-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/end-video-call":{"post":{"summary":"End video call for the connected user","description":"Manually ends an active video call session for the connected user. This endpoint is typically used by system to forcefully close a session that is still ongoing.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/end-video-call"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/end-video-call-response"}}}}}}},"/get-screening-delta-records":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-screening-delta-records"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-screening-delta-records-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"wrong-parameters"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"access-denied"}}]}}}}}}},"/get-question-file":{"post":{"summary":"Get file from the question","description":"This endpoint allows you to retrieve a file attached to a specific question in a questionnaire.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.\r\n-   `stepKey` _(string, required)_ – The unique key of the questionnaire step.\r\n-   `questionKey`_(string, required)_ – The unique key of the question within the questionnaire.\r\n-   `fileIndex` _(integer, optional)_ – The index of the file when multiple files are uploaded to a question. This is used to reference a specific file within the question’s attachments.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-question-file"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-question-file-response"}}}}}}},"/get-visual-markers":{"post":{"summary":"Get document visual markers","description":"This endpoint retrieves the visual markers from a document.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.  \r\n-   `sessionId` _(string, required)_ - The unique identifier of the session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-visual-markers"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-visual-markers-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"not-found"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/compare-faces":{"post":{"summary":"Get a similarity score for two faces","description":"The minimum recommended face size in the picture is **80 pixels**. If the face size is between **65-79 pixels**, an error code will be returned along with the similarity score.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` (string, required) - The company's secret key.\r\n-   `face1` _(file, required)_ - A JPEG or PDF file for face1\r\n-   `face2` _(file, required)_ - A JPEG or PDF file for face2","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/compare-faces"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/compare-faces-response"}}}}}}},"/check-spoofing":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-spoofing"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-spoofing-response"}}}}}}},"/list-blacklist-records":{"post":{"summary":"List all blacklist records assosiated with the company","description":"Retrieves all blacklist records associated with the company. You can optionally filter records by a query, set pagination with `offset` and `limit`, or retrieve the full list.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   query (object of strings, optional) - Optional filter fields:\r\n    -   `offset` (number, optional) - Number of records to skip from the beginning.\r\n    -   `limit` (number, optional) - Maximum number of records to return.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-blacklist-records"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-blacklist-records-response"}}}}}}},"/remove-blacklist-record":{"post":{"summary":"Remove record from the blacklist","description":"Removes previously added record from the blacklist.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `id` (string, required) - Blacklist record ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/remove-blacklist-record"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/remove-blacklist-record-response"}}}}}}},"/add-blacklist-record":{"post":{"summary":"Add person to the blacklist","description":"Adds a person to the blacklist based on identifying attributes such as name, document number, or personal number.\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `query` _(object of strings, required)_ - Object containing query details. **Must include** `reason` and **at least one of** the following: `firstName`, `lastName`, `personalNumber`, `documentNumber`, `birthday`.\r\n    -   firstName (string, optional) - First name of the individual.\r\n    -   lastName (string, optional) - Last name of the individual.\r\n    -   personalNumber (string, optional) - Personal identification number.\r\n    -   documentNumber (string, optional) - Document number (e.g., from an ID or passport).\r\n    -   birthday (string, optional) - Birthday in ISO 8601 format (e.g., 1990-05-14).\r\n    -   reason (string, required) - The reason for blacklisting the individual.\r\n    -  notes (string, optional) - Additional information or context about the blacklisting that may be useful for record-keeping or future reference.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add-blacklist-record"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/add-blacklist-record-response"}}}}}}},"/create-user":{"post":{"summary":"Create a user","description":"Creates a new user for the Identomat platform (Manage).\r\n\r\n**Parameters:**\r\n\r\n-   `companyKey` _(string, required)_ - The company's secret key.\r\n-   `email` _(string, required)_ - The email address of the new user.\r\n-   `emailVerified` (boolean, optional) - Whether the email should be marked as verified. Defaults to `false`.\r\n-   `password` (string, required) - The user’s password (minimum 8 characters).\r\n-   `firstName` (string, optional) - First name of the user.\r\n-   `lastName` (string, optional) - Last name of the user.\r\n-   `rights` (array of strings, optional) - List of roles to assign to the user. If omitted, defaults to `call_center_operator`. Valid values are:\r\n    -   `call_center_operator`\r\n    -   `operator`\r\n    -   `administrator`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create-user"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/create-user-response"}}}}}}},"/get-trusted-database-record":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-trusted-database-record"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-trusted-database-record-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"wrong-parameters"}},{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"no-trusted-database-sources"}}]}}}}}}},"/get-file":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-file"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-file-response"}}}}}}},"/delete-file":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-file"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-file-response"}}}}}}},"/upload-file":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/upload-file"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/upload-file-response"}}}}}}},"/result":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/result"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/result-response"}}}}}}},"/delete-user":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-user"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-user-response"}}}}}}},"/delete-session":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-session"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete-session-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"wrong-parameters"}}]}}}}}}},"/begin":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/begin"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/begin-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"additionalSessionId":{"type":"string"},"additionalSessionUrl":{"type":"string"}},"example":{"id":"test-session-id","url":"https://widget.identomat.dev/?session_token=child-session-id","additionalSessionId":"child-session-id","additionalSessionUrl":"https://widget.identomat.dev/?session_token=child-session-id"}},{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"additionalSessionId":{"type":"string"},"additionalSessionUrl":{"type":"string"}},"example":{"id":"test-session-id","url":"https://widget.identomat.dev/?session_token=child-session-id","additionalSessionId":"child-session-id","additionalSessionUrl":"https://widget.identomat.dev/?session_token=child-session-id"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"wrong-parameters"}},{"type":"object","properties":{"argumentError":{"type":"string"}},"example":{"argumentError":"invalid-access"}}]}}}}}}},"/check-in-datazoo":{"post":{"summary":"endpoint","description":"","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-in-datazoo"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/check-in-datazoo-response"}}}},"400":{"description":"ArgumntError","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"wrong-parameters"}},{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"no-datazoo-source"}}]}}}}}}}},"components":{"schemas":{"list-session-activities":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"list-session-activities-response":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"time":{"type":"string","format":"date-time"},"data":{"type":"object","properties":{},"example":{}}},"example":{"id":"6162636465666768696a6b6c","type":"PAGE_LOADED","time":"2021-12-29T11:30:39.086Z","data":{}}}}},"example":{"result":[{"id":"6162636465666768696a6b6c","type":"PAGE_LOADED","time":"2021-12-29T11:30:39.086Z","data":{}},{"id":"5ff45878f44e95bbf987a801","type":"PAGE_LOADED","time":"2011-12-29T11:30:39.086Z","data":{}}]}},"get-session-main-document-face-photo":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"get-session-main-document-face-photo-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"data:text/plain;base64String"}},"get-session-statistical-summary":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"get-session-statistical-summary-response":{"type":"object","properties":{"result":{"type":"object","properties":{"sessionStartDate":{"type":"string","format":"date-time"},"sessionTimeSpan":{"type":"number"},"scanDocumentStartTime":{"type":"string","format":"date-time"},"scanDocumentEndTime":{"type":"string","format":"date-time"},"scanDocumentAttempts":{"type":"number"},"scanDocumentFailReason":{"type":"string"},"livenessStartTime":{"type":"string","format":"date-time"},"livenessEndTime":{"type":"string","format":"date-time"},"livenessFailReasons":{"type":"string"},"sessionTerminationStep":{"type":"string"},"sessionTerminationReasons":{"type":"string"}},"example":{"sessionStartDate":"2021-11-07T13:31:45.140Z","sessionTimeSpan":30000,"scanDocumentStartTime":"2021-11-07T13:31:45.140Z","scanDocumentEndTime":"2021-11-07T13:31:45.140Z","scanDocumentAttempts":2,"scanDocumentFailReason":null,"livenessStartTime":"2021-11-07T13:31:45.140Z","livenessEndTime":"2021-11-07T13:31:45.140Z","livenessFailReasons":null,"sessionTerminationStep":null,"sessionTerminationReasons":null}}},"example":{"result":{"sessionStartDate":"2021-11-07T13:31:45.140Z","sessionTimeSpan":30000,"scanDocumentStartTime":"2021-11-07T13:31:45.140Z","scanDocumentEndTime":"2021-11-07T13:31:45.140Z","scanDocumentAttempts":2,"scanDocumentFailReason":null,"livenessStartTime":"2021-11-07T13:31:45.140Z","livenessEndTime":"2021-11-07T13:31:45.140Z","livenessFailReasons":null,"sessionTerminationStep":null,"sessionTerminationReasons":null}}},"search-screening-person":{"type":"object","properties":{"companyKey":{"type":"string"},"query":{"type":"object","properties":{"birthdayTimeFrom":{"type":"string","format":"date-time"},"fullName":{"type":"string"},"scoreThreshold":{"type":"number"}},"example":{"birthdayTimeFrom":"1980-11-07T13:07:59.790Z","fullName":"John Doe","scoreThreshold":80}},"offset":{"type":"number"},"limit":{"type":"number"}},"example":{"companyKey":"your-company-secret-key","query":{"birthdayTimeFrom":"1980-11-07T13:07:59.790Z","fullName":"John Doe","scoreThreshold":80},"offset":0,"limit":100}},"search-screening-person-response":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string"},"entityType":{"type":"string"},"name":{"type":"string"},"score":{"type":"number"},"topics":{"type":"array","items":{"type":"string"}}},"example":{"personId":"666010a771e39d01b5023d0f","entityType":"person","name":"John Doe","score":100,"topics":["Sanctioned entity","Wanted person","Person of interest","Politician"]}}}},"example":{"result":[{"personId":"666010a771e39d01b5023d0f","entityType":"person","name":"John Doe","score":100,"topics":["Sanctioned entity","Wanted person","Person of interest","Politician"]}]}},"get-screening-person-details":{"type":"object","properties":{"personId":{"type":"string"},"companyKey":{"type":"string"}},"example":{"personId":"example-person-id-12345","companyKey":"your-company-secret-key"}},"get-screening-person-details-response":{"type":"object","properties":{"result":{"type":"object","properties":{"entityType":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"gender":{"type":"string"},"birthdayTime":{"type":"string"},"nationality":{"type":"string"},"extraDetails":{"type":"array","items":{"type":"object","properties":{"groupName":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"detailName":{"type":"string"},"properties":{"type":"array","items":{"type":"object","properties":{"propertyName":{"type":"string"},"value":{"type":"array","items":{"type":"string"}},"type":{"type":"string"}},"example":{"propertyName":"Position","value":["President of US (2012-)","chairperson","party leader"],"type":"list"}}}},"example":{"detailName":"John Doe Smith","properties":[{"propertyName":"Position","value":["President of US (2012-)","chairperson","party leader"],"type":"list"},{"propertyName":"Name","value":["John Doe Smith","约翰·多·史密斯","Джон Доу Сміт"],"type":"list"},{"propertyName":"Alias","value":["John Smith"],"type":"list"}]}}}},"example":{"groupName":"Profile","details":[{"detailName":"John Doe Smith","properties":[{"propertyName":"Position","value":["President of US (2012-)","chairperson","party leader"],"type":"list"},{"propertyName":"Name","value":["John Doe Smith","约翰·多·史密斯","Джон Доу Сміт"],"type":"list"},{"propertyName":"Alias","value":["John Smith"],"type":"list"}]}]}}}},"example":{"entityType":"person","firstName":"John","middleName":"Doe","lastName":"Smith","gender":"male","birthdayTime":"1952-10-07","nationality":"US","extraDetails":[{"groupName":"Profile","details":[{"detailName":"John Doe Smith","properties":[{"propertyName":"Position","value":["President of US (2012-)","chairperson","party leader"],"type":"list"},{"propertyName":"Name","value":["John Doe Smith","约翰·多·史密斯","Джон Доу Сміт"],"type":"list"},{"propertyName":"Alias","value":["John Smith"],"type":"list"}]}]},{"groupName":"Position occupied","details":[{"detailName":"President","properties":[{"propertyName":"Name","value":["President of US","President"],"type":"string"},{"propertyName":"Start Date","value":["1999-08-16"],"type":"date"},{"propertyName":"End Date","value":["2000-05-07"],"type":"date"},{"propertyName":"Status","value":["active"],"type":"string"}]}]},{"groupName":"Sanctions","details":[{"detailName":"Department of Foreign Affairs and Trade","properties":[{"propertyName":"Start Date","value":["2022-02-28"],"type":"date"},{"propertyName":"Authority","value":["Department of Foreign Affairs and Trade"],"type":"string"},{"propertyName":"Program","value":[""],"type":"string"},{"propertyName":"Entity","value":["Q772247"],"type":"string"},{"propertyName":"Summary","value":["Instrument of first designation and declaration: Autonomous Sanctions ....."],"type":"string"},{"propertyName":"Source Url","value":["https://www.dfat.gov.au/international-relations/security/sanctions/Pages3/"],"type":"url"}]}]}]}}},"example":{"result":{"entityType":"person","firstName":"John","middleName":"Doe","lastName":"Smith","gender":"male","birthdayTime":"1952-10-07","nationality":"US","extraDetails":[{"groupName":"Profile","details":[{"detailName":"John Doe Smith","properties":[{"propertyName":"Position","value":["President of US (2012-)","chairperson","party leader"],"type":"list"},{"propertyName":"Name","value":["John Doe Smith","约翰·多·史密斯","Джон Доу Сміт"],"type":"list"},{"propertyName":"Alias","value":["John Smith"],"type":"list"}]}]},{"groupName":"Position occupied","details":[{"detailName":"President","properties":[{"propertyName":"Name","value":["President of US","President"],"type":"string"},{"propertyName":"Start Date","value":["1999-08-16"],"type":"date"},{"propertyName":"End Date","value":["2000-05-07"],"type":"date"},{"propertyName":"Status","value":["active"],"type":"string"}]}]},{"groupName":"Sanctions","details":[{"detailName":"Department of Foreign Affairs and Trade","properties":[{"propertyName":"Start Date","value":["2022-02-28"],"type":"date"},{"propertyName":"Authority","value":["Department of Foreign Affairs and Trade"],"type":"string"},{"propertyName":"Program","value":[""],"type":"string"},{"propertyName":"Entity","value":["Q772247"],"type":"string"},{"propertyName":"Summary","value":["Instrument of first designation and declaration: Autonomous Sanctions ....."],"type":"string"},{"propertyName":"Source Url","value":["https://www.dfat.gov.au/international-relations/security/sanctions/Pages3/"],"type":"url"}]}]}]}}},"get-video-call-shots":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"get-video-call-shots-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"data:application/x-tar;base64,base64String"}},"remove-screening-query-from-monitoring":{"type":"object","properties":{"companyKey":{"type":"string"},"id":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","id":"64ad3b14090678e34512eab8"}},"remove-screening-query-from-monitoring-response":{"type":"object","properties":{"result":{"type":"boolean"}},"example":{"result":true}},"list-screening-monitoring-records":{"type":"object","properties":{"companyKey":{"type":"string"},"start":{"type":"number"},"limit":{"type":"number"}},"example":{"companyKey":"your-company-secret-key","start":0,"limit":50}},"list-screening-monitoring-records-response":{"type":"object","properties":{"result":{"type":"object","properties":{"start":{"type":"number"},"limit":{"type":"number"},"total":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"fullName":{"type":"string"},"id":{"type":"string"}},"example":{"fullName":"John Smith1","id":"64ad3b14090678e34512eab8"}}}},"example":{"start":0,"limit":50,"total":4,"data":[{"fullName":"John Smith1","id":"64ad3b14090678e34512eab8"},{"fullName":"John Smith2","id":"64ad3ef45fcf054afc73ebb4","lastUpdatedDate":"2023-07-01T10:50:42.389Z"},{"fullName":"John Smith3","id":"64ad3f3a8b3f54aca29fc0a2","lastUpdatedDate":"2023-07-20T10:50:42.389Z"},{"fullName":"John Smith4","id":"64ad3f3a8b3f54aca29fc0a3"}]}}},"example":{"result":{"start":0,"limit":50,"total":4,"data":[{"fullName":"John Smith1","id":"64ad3b14090678e34512eab8"},{"fullName":"John Smith2","id":"64ad3ef45fcf054afc73ebb4","lastUpdatedDate":"2023-07-01T10:50:42.389Z"},{"fullName":"John Smith3","id":"64ad3f3a8b3f54aca29fc0a2","lastUpdatedDate":"2023-07-20T10:50:42.389Z"},{"fullName":"John Smith4","id":"64ad3f3a8b3f54aca29fc0a3"}]}}},"monitor-screening-query":{"type":"object","properties":{"companyKey":{"type":"string"},"query":{"type":"object","properties":{"fullName":{"type":"string"},"birthdayTimeFrom":{"type":"string"}},"example":{"fullName":"John Doe","birthdayTimeFrom":"1982-12-12T00:00:00Z"}}},"example":{"companyKey":"your-company-secret-key","query":{"fullName":"John Doe","birthdayTimeFrom":"1982-12-12T00:00:00Z"}}},"monitor-screening-query-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"64ad3b14090678e34512eab8"}},"export-session-as-pdf":{"type":"object","properties":{"sessionId":{"type":"string"},"companyKey":{"type":"string"},"exportSession":{"type":"boolean"},"exportScreening":{"type":"boolean"},"exportProofOfAddress":{"type":"boolean"}},"example":{"sessionId":"example-session-id-12345","companyKey":"your-company-secret-key","exportSession":true,"exportScreening":false,"exportProofOfAddress":false}},"export-session-as-pdf-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"data:application/pdf;base64,ABCD"}},"get-video-call-videos":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"get-video-call-videos-response":{"type":"object","properties":{"result":{"type":"object","properties":{"contentType":{"type":"string"}},"example":{"contentType":"application/x-tar"}}},"example":{"result":{"contentType":"application/x-tar"}}},"list-groups":{"type":"object","properties":{"companyKey":{"type":"string"}},"example":{"companyKey":"your-company-secret-key"}},"list-groups-response":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"memberUserIds":{"type":"array","items":{"type":"string"}}},"example":{"id":"650976e8dc32104b8bb1757e","name":"group-name","description":"group-description","memberUserIds":["64f4d0ec35f5bb20a8022012","64f4d10435f5bb20a8022013","64f4d12335f5bb20a8022014"]}}}},"example":{"result":[{"id":"650976e8dc32104b8bb1757e","name":"group-name","description":"group-description","memberUserIds":["64f4d0ec35f5bb20a8022012","64f4d10435f5bb20a8022013","64f4d12335f5bb20a8022014"]}]}},"list-users":{"type":"object","properties":{"companyKey":{"type":"string"}},"example":{"companyKey":"61e0168e4a324c6077636306_8560ad4d6d9dc4e04d3754f3dfee130b07c59fcd"}},"list-users-response":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"example":{"id":"user_id","username":"user@identomat.com","roles":["administrator","operator","call_center_operator"]}}}},"example":{"result":[{"id":"user_id","username":"user@identomat.com","roles":["administrator","operator","call_center_operator"]}]}},"get-session-config":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionConfigId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionConfigId":"6162636465666768696a6b6c"}},"get-session-config-response":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"general":{"type":"object","properties":{"language":{"type":"string"},"sessionLifetime":{"type":"number"}},"example":{"language":"en","sessionLifetime":15}},"steps":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"en":{"type":"string"}},"example":{"en":"ID Verification"}},"type":{"type":"string"},"key":{"type":"string"},"flags":{"type":"object","properties":{"documentTypes":{"type":"array","items":{"type":"string"}}},"example":{"documentTypes":["id","passport","driver_license","residence_permit"]}}},"example":{"title":{"en":"ID Verification"},"type":"identity-document","key":"select_document_id","flags":{"documentTypes":["id","passport","driver_license","residence_permit"]}}}}},"example":{"id":"679c74e4d9725987e3879265","name":"Configuration Template","general":{"language":"en","sessionLifetime":15},"steps":[{"title":{"en":"ID Verification"},"type":"identity-document","key":"select_document_id","flags":{"documentTypes":["id","passport","driver_license","residence_permit"]}},{"title":{"en":"Liveness Check"},"type":"liveness","key":"liveness","flags":{"liveness":true,"maxLivenessAttempts":3}}]}}},"example":{"result":{"id":"679c74e4d9725987e3879265","name":"Configuration Template","general":{"language":"en","sessionLifetime":15},"steps":[{"title":{"en":"ID Verification"},"type":"identity-document","key":"select_document_id","flags":{"documentTypes":["id","passport","driver_license","residence_permit"]}},{"title":{"en":"Liveness Check"},"type":"liveness","key":"liveness","flags":{"liveness":true,"maxLivenessAttempts":3}}]}}},"change-group":{"type":"object","properties":{"companyKey":{"type":"string"},"groupId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"memberIds":{"type":"array","items":{"type":"string"}}},"example":{"companyKey":"your-company-secret-key","groupId":"64a50a0c6c2ff7f9a1f12833","name":"Group 1","description":"Group 1 description","memberIds":["user1_id","user2_id"]}},"change-group-response":{"type":"object","properties":{},"example":{}},"delete-group":{"type":"object","properties":{"companyKey":{"type":"string"},"groupId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","groupId":"64b63613ad6f7ccaec256773"}},"delete-group-response":{"type":"object","properties":{"result":{"type":"object","properties":{},"example":{}}},"example":{"result":{}}},"make-group":{"type":"object","properties":{"companyKey":{"type":"string"},"name":{"type":"string"},"memberIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","name":"GroupName","memberIds":["user1_id","user2_id"],"description":"GroupDescription"}},"make-group-response":{"type":"object","properties":{"result":{"type":"object","properties":{"id":{"type":"string"}},"example":{"id":"groupId"}}},"example":{"result":{"id":"groupId"}}},"end-video-call":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"end-video-call-response":{"type":"object","properties":{},"example":{}},"get-screening-delta-records":{"type":"object","properties":{"companyKey":{"type":"string"}},"example":{"companyKey":"abcd"}},"get-screening-delta-records-response":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"fullName":{"type":"string"},"schema":{"type":"string"}},"example":{"date":"2024-11-27T00:00:00.000Z","fullName":"Tesla","schema":"Company"}}}},"example":{"result":[{"date":"2024-11-27T00:00:00.000Z","fullName":"Tesla","schema":"Company"},{"birthDate":"1998-04-05","date":"2024-11-27T00:00:00.000Z","fullName":"Elon Musk","schema":"Person"}]}},"get-question-file":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"},"stepKey":{"type":"string"},"questionKey":{"type":"string"},"fileIndex":{"type":"number"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345","stepKey":"user-questionnaire-1","questionKey":"question-1","fileIndex":0}},"get-question-file-response":{"type":"object","properties":{"result":{"type":"object","properties":{"contentType":{"type":"string"}},"example":{"contentType":"application/pdf | image/png | image/jpeg"}}},"example":{"result":{"contentType":"application/pdf | image/png | image/jpeg"}}},"get-visual-markers":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"example-session-id-12345"}},"get-visual-markers-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"data:application/x-tar;base64,base64String"}},"compare-faces":{"type":"object","properties":{"companyKey":{"type":"string"},"face1":{"type":"object","properties":{"contentType":{"type":"string"}},"example":{"contentType":"application/pdf"}},"face2":{"type":"object","properties":{"contentType":{"type":"string"}},"example":{"contentType":"application/pdf"}}},"example":{"companyKey":"your-company-secret-key","face1":{"contentType":"application/pdf"},"face2":{"contentType":"application/pdf"}}},"compare-faces-response":{"type":"object","properties":{"result":{"type":"object","properties":{"similarity":{"type":"number"},"face1Statuses":{"type":"array","items":{}},"face2Statuses":{"type":"array","items":{}}},"example":{"similarity":0.9399788229619535,"face1Statuses":[],"face2Statuses":[]}}},"example":{"result":{"similarity":0.9399788229619535,"face1Statuses":[],"face2Statuses":[]}}},"check-spoofing":{"type":"object","properties":{"companyKey":{"type":"string"},"file":{"type":"string"}},"example":{"companyKey":"companyKey","file":"video base64 or bytes"}},"check-spoofing-response":{"type":"object","properties":{"result":{"type":"object","properties":{"isSpoof":{"type":"boolean"},"statuses":{"type":"array","items":{}}},"example":{"isSpoof":true,"statuses":[]}}},"example":{"result":{"isSpoof":true,"statuses":[]}}},"list-blacklist-records":{"type":"object","properties":{"companyKey":{"type":"string"}},"example":{"companyKey":"your-company-secret-key"}},"list-blacklist-records-response":{"type":"object","properties":{"result":{"type":"object","properties":{"offset":{"type":"number"},"limit":{"type":"number"},"total":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"documentNumber":{"type":"string"},"personalNumber":{"type":"string"},"birthday":{"type":"string","format":"date-time"},"reason":{"type":"string"},"notes":{"type":"string"},"id":{"type":"string"}},"example":{"firstName":"John","lastName":"Doe","documentNumber":"123ABC123","personalNumber":"012345678901","birthday":"1980-01-01T00:00:00.000Z","reason":"Reason for adding to blacklist","notes":"Fraud-related activity","id":"64f4d0ec35f5bb20a8022012"}}}},"example":{"offset":0,"limit":100,"total":1,"data":[{"firstName":"John","lastName":"Doe","documentNumber":"123ABC123","personalNumber":"012345678901","birthday":"1980-01-01T00:00:00.000Z","reason":"Reason for adding to blacklist","notes":"Fraud-related activity","id":"64f4d0ec35f5bb20a8022012"}]}}},"example":{"result":{"offset":0,"limit":100,"total":1,"data":[{"firstName":"John","lastName":"Doe","documentNumber":"123ABC123","personalNumber":"012345678901","birthday":"1980-01-01T00:00:00.000Z","reason":"Reason for adding to blacklist","notes":"Fraud-related activity","id":"64f4d0ec35f5bb20a8022012"}]}}},"remove-blacklist-record":{"type":"object","properties":{"companyKey":{"type":"string"},"id":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","id":"5808755c0b4adccd6f43d811"}},"remove-blacklist-record-response":{"type":"object","properties":{"result":{"type":"boolean"}},"example":{"result":true}},"add-blacklist-record":{"type":"object","properties":{"companyKey":{"type":"string"},"query":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"documentNumber":{"type":"string"},"personalNumber":{"type":"string"},"birthday":{"type":"string","format":"date-time"},"reason":{"type":"string"},"notes":{"type":"string"}},"example":{"firstName":"John","lastName":"Doe","documentNumber":"123ABC123","personalNumber":"12345678901","birthday":"1980-01-01T00:00:00.000Z","reason":"Reason for adding to blacklist","notes":"Fraud-related activity"}}},"example":{"companyKey":"your-company-secret-key","query":{"firstName":"John","lastName":"Doe","documentNumber":"123ABC123","personalNumber":"12345678901","birthday":"1980-01-01T00:00:00.000Z","reason":"Reason for adding to blacklist","notes":"Fraud-related activity"}}},"add-blacklist-record-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"64ad3b14090678e34512eab8"}},"create-user":{"type":"object","properties":{"companyKey":{"type":"string"},"email":{"type":"string"},"emailVerified":{"type":"boolean"},"password":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"rights":{"type":"array","items":{"type":"string"}}},"example":{"companyKey":"your-company-secret-key","email":"john.doe@example.com","emailVerified":true,"password":"SecurePass123!","firstName":"John","lastName":"Doe","rights":["call_center_operator","administrator","operator"]}},"create-user-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"userId"}},"get-trusted-database-record":{"type":"object","properties":{"companyKey":{"type":"string"},"privateNumber":{"type":"string"},"birthdayTime":{"type":"string","format":"date-time"},"sessionId":{"type":"string"},"issuingState":{"type":"string"}},"example":{"companyKey":"61e0168e4a324c6077636306_8560ad4d6d9dc4e04d3754f3dfee130b07c59fcd","privateNumber":"2003048073405","birthdayTime":"1987-01-01T00:00:00.000Z","sessionId":"kxvt2bn1mbqf3ral74i56zggbcdw3rabxhpey84y","issuingState":"MDA"}},"get-trusted-database-record-response":{"type":"object","properties":{"result":{"type":"object","properties":{"privateNumber":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"lastNameEn":{"type":"string"},"firstNameEn":{"type":"string"},"birthdayTime":{"type":"string","format":"date-time"},"genderId":{"type":"string"},"birthPlaceCountry":{"type":"string"},"birthPlaceCountryCode":{"type":"string"},"birthPlaceRaion":{"type":"string"},"citizenshipCountry":{"type":"string"},"citizenshipCountryCode":{"type":"string"},"personStatus":{"type":"string"},"personStatusId":{"type":"string"},"photo":{"type":"object","properties":{"photo":{"type":"string"}},"example":{"photo":"base64"}},"document":{"type":"object","properties":{"docTypeId":{"type":"string"},"docTypeName":{"type":"string"},"number":{"type":"string"},"issueDate":{"type":"string","format":"date-time"},"issuerName":{"type":"string"},"expireDate":{"type":"string","format":"date-time"},"statusId":{"type":"string"},"status":{"type":"string"}},"example":{"docTypeId":"7","docTypeName":"პირადობის ელექტრონული მოწმობა","number":"123","issueDate":"2023-01-01T00:00:00.000Z","issuerName":"იუსტიციის სამინისტრო","expireDate":"2030-01-01T00:00:00.000Z","statusId":"Active","status":"Active"}},"address":{"type":"object","properties":{"activeAddressAddressId":{"type":"string"},"activeAddressAddressSource":{"type":"string"},"oaId":{"type":"string"},"addrStatusId":{"type":"string"},"addressStatus":{"type":"string"},"activeAddress":{"type":"string"},"activeAddressRaion":{"type":"string"},"activeAddressRegion":{"type":"string"},"activeAddressCity":{"type":"string"},"activeAddressCountry":{"type":"string"}},"example":{"activeAddressAddressId":"123","activeAddressAddressSource":"NAPR","oaId":"123","addrStatusId":"Active","addressStatus":"Active","activeAddress":"123","activeAddressRaion":"ვაკე","activeAddressRegion":"თბილისი","activeAddressCity":"თბილისი","activeAddressCountry":"საქართველო"}}},"example":{"privateNumber":"123","lastName":"123","firstName":"123","lastNameEn":"123","firstNameEn":"123","birthdayTime":"1987-01-01T00:00:00.000Z","genderId":"Male","birthPlaceCountry":"საქართველო","birthPlaceCountryCode":"GE","birthPlaceRaion":"ვაკე","citizenshipCountry":"საქართველო","citizenshipCountryCode":"GE","personStatus":"Active","personStatusId":"Active","photo":{"photo":"base64"},"document":{"docTypeId":"7","docTypeName":"პირადობის ელექტრონული მოწმობა","number":"123","issueDate":"2023-01-01T00:00:00.000Z","issuerName":"იუსტიციის სამინისტრო","expireDate":"2030-01-01T00:00:00.000Z","statusId":"Active","status":"Active"},"address":{"activeAddressAddressId":"123","activeAddressAddressSource":"NAPR","oaId":"123","addrStatusId":"Active","addressStatus":"Active","activeAddress":"123","activeAddressRaion":"ვაკე","activeAddressRegion":"თბილისი","activeAddressCity":"თბილისი","activeAddressCountry":"საქართველო"}}}},"example":{"result":{"privateNumber":"123","lastName":"123","firstName":"123","lastNameEn":"123","firstNameEn":"123","birthdayTime":"1987-01-01T00:00:00.000Z","genderId":"Male","birthPlaceCountry":"საქართველო","birthPlaceCountryCode":"GE","birthPlaceRaion":"ვაკე","citizenshipCountry":"საქართველო","citizenshipCountryCode":"GE","personStatus":"Active","personStatusId":"Active","photo":{"photo":"base64"},"document":{"docTypeId":"7","docTypeName":"პირადობის ელექტრონული მოწმობა","number":"123","issueDate":"2023-01-01T00:00:00.000Z","issuerName":"იუსტიციის სამინისტრო","expireDate":"2030-01-01T00:00:00.000Z","statusId":"Active","status":"Active"},"address":{"activeAddressAddressId":"123","activeAddressAddressSource":"NAPR","oaId":"123","addrStatusId":"Active","addressStatus":"Active","activeAddress":"123","activeAddressRaion":"ვაკე","activeAddressRegion":"თბილისი","activeAddressCity":"თბილისი","activeAddressCountry":"საქართველო"}}}},"get-file":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"},"stepKey":{"type":"string"},"questionKey":{"type":"string"},"filename":{"type":"string"}},"example":{"companyKey":"abcd","sessionId":"session-123","stepKey":"user-questionnaire-3","questionKey":"question-1","filename":"3e8c5ae74df054fa18fb81c5b138ecb05d062eb1"}},"get-file-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"stream"}},"delete-file":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"},"stepKey":{"type":"string"},"questionKey":{"type":"string"},"filename":{"type":"string"}},"example":{"companyKey":"abcd","sessionId":"session-123","stepKey":"user-questionnaire-3","questionKey":"question-1","filename":"3e8c5ae74df054fa18fb81c5b138ecb05d062eb1"}},"delete-file-response":{"type":"object","properties":{"result":{"type":"boolean"}},"example":{"result":true}},"upload-file":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"},"stepKey":{"type":"string"},"questionKey":{"type":"string"},"content":{"type":"string"}},"example":{"companyKey":"abcd","sessionId":"session-123","stepKey":"user-questionnaire-1","questionKey":"question-1","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII"}},"upload-file-response":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"3e8c5ae74df054fa18fb81c5b138ecb05d062eb1"}},"result":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"61e0168e4a324c6077636306_8560ad4d6d9dc4e04d3754f3dfee130b07c59fcd","sessionId":"b02ebb65f0ec30dbcfa2f12f239f2e975747bb2e"}},"result-response":{"type":"object","properties":{"result":{"type":"object","properties":{"result":{"type":"string"},"stepsResults":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"result":{"type":"object","properties":{"question4":{"type":"string"},"question2":{"type":"string"}},"example":{"question4":"JAAK KRSTJAN JOEORG","question2":"option1"}},"status":{"type":"string"}},"example":{"key":"agreement-1","type":"user-questionnaire","result":{"question4":"JAAK KRSTJAN JOEORG","question2":"option1"},"status":"approved"}}},"technicalDetails":{"type":"object","properties":{"remoteAddress":{"type":"string"},"userAgent":{"type":"string"}},"example":{"remoteAddress":"10.244.2.1","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:84.0) Gecko/20100101 Firefox/84.0"}},"screeningMatches":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number"},"name":{"type":"string"},"personId":{"type":"string"}},"example":{"score":100,"name":"Donald John Trump","personId":"623c38ebfd756473ed187310"}}}},"example":{"result":"IN_PROGRESS","stepsResults":[{"key":"agreement-1","type":"user-questionnaire","result":{"question4":"JAAK KRSTJAN JOEORG","question2":"option1"},"status":"approved"},{"key":"company","type":"company","result":{"companyName":"123","registrationNumber":"wde","legalAddress":"","registrationCountry":"Algeria","companyEntityType":"","taxId":"13","dateOfIncorporation":"","contactNumber":"","email":""},"status":"approved"},{"key":"beneficiaries","type":"beneficiaries","result":[{"type":"individual","position":["shareholder"],"entityType":"individual","ownershipPercentage":"100","firstName":"daad","lastName":"adad","dateOfBirth":"07/10/2020"}],"status":"approved"},{"key":"kyb-review","type":"kyb-review","status":"approved"}],"technicalDetails":{"remoteAddress":"10.244.2.1","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:84.0) Gecko/20100101 Firefox/84.0"},"screeningMatches":[{"score":100,"name":"Donald John Trump","personId":"623c38ebfd756473ed187310"},{"score":83,"name":"Ajayi Damilola Leke","personId":"623c38ebfd756473ed187311"},{"score":81,"name":"Olebogeng Gobusamang","personId":"623c38ebfd756473ed187312"}]}}},"example":{"result":{"result":"IN_PROGRESS","stepsResults":[{"key":"agreement-1","type":"user-questionnaire","result":{"question4":"JAAK KRSTJAN JOEORG","question2":"option1"},"status":"approved"},{"key":"company","type":"company","result":{"companyName":"123","registrationNumber":"wde","legalAddress":"","registrationCountry":"Algeria","companyEntityType":"","taxId":"13","dateOfIncorporation":"","contactNumber":"","email":""},"status":"approved"},{"key":"beneficiaries","type":"beneficiaries","result":[{"type":"individual","position":["shareholder"],"entityType":"individual","ownershipPercentage":"100","firstName":"daad","lastName":"adad","dateOfBirth":"07/10/2020"}],"status":"approved"},{"key":"kyb-review","type":"kyb-review","status":"approved"}],"technicalDetails":{"remoteAddress":"10.244.2.1","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:84.0) Gecko/20100101 Firefox/84.0"},"screeningMatches":[{"score":100,"name":"Donald John Trump","personId":"623c38ebfd756473ed187310"},{"score":83,"name":"Ajayi Damilola Leke","personId":"623c38ebfd756473ed187311"},{"score":81,"name":"Olebogeng Gobusamang","personId":"623c38ebfd756473ed187312"}]}}},"delete-user":{"type":"object","properties":{"companyKey":{"type":"string"},"userId":{"type":"string"}},"example":{"companyKey":"company-key-example-1234","userId":"user-id-example-1234"}},"delete-user-response":{"type":"object","properties":{"result":{"type":"object","properties":{},"example":{}}},"example":{"result":{}}},"delete-session":{"type":"object","properties":{"companyKey":{"type":"string"},"sessionId":{"type":"string"}},"example":{"companyKey":"your-company-secret-key","sessionId":"64b63613ad6f7ccaec256773"}},"delete-session-response":{"type":"string"},"begin":{"type":"object","properties":{"companyKey":{"type":"string"},"configId":{"type":"string"}},"example":{"companyKey":"test-company-key","configId":"test-config-id"}},"begin-response":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"}},"example":{"id":"test-session-id","url":"https://widget.identomat.dev/?session_token=test-session-id"}},"check-in-datazoo":{"type":"object","properties":{"companyKey":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"nationalIdNo":{"type":"string"},"dateOfBirth":{"type":"string"},"addressLine":{"type":"string"},"lga":{"type":"string"},"state":{"type":"string"},"clientReference":{"type":"string"}},"example":{"companyKey":"61e0168e4a324c6077636306_8560ad4d6d9dc4e04d3754f3dfee130b07c59fcd","firstName":"guion","lastName":"audi","nationalIdNo":"18482561982","dateOfBirth":"1974-01-06","addressLine":"1193 kuba road","lga":"abuja municipal","state":"fct abuja","clientReference":"test 0001"}},"check-in-datazoo-response":{"type":"object","properties":{"result":{"type":"object","properties":{"countrycode":{"type":"string"},"searchstatus":{"type":"string"}},"example":{"countrycode":"nigeria","searchstatus":"successful"}}},"example":{"result":{"countrycode":"nigeria","searchstatus":"successful"}}}}}}