Enums
Enums
Application
Values
| Value | Description |
|---|---|
| AML_API | AML API version. |
| AML_UI | AML UI design. |
| AML_MOBILE_SDK | AML Mobile SDK version. |
| AML_VERIFY_APP | AML verify application version. |
CheckStatus
Values
| Value | Description |
|---|---|
| INITIATED | The user launches session check. |
| STARTED | Session check is evoked, internal status, and will not be presented to end-user. |
| PROCESSING | The check will have this status as long as the check session is processed. It will remain in this status until it is finished. |
| VALID_INPUT | The input data is validated; internal status and will not be presented to the end-user. |
| PASSED | All results are false positive, and there are no true positive. |
| NOT_PASSED | One or more check results are true positive or pending. |
| ERROR | The session will return this result and an error message in case of any problems while processing the input data. |
CheckType
Values
| Value | Description |
|---|---|
| PERSONAL | The data that needs to be verified is personal data. |
| ADDRESS | The data that needs to be verified is address data. |
| LOCATION | Location data is the data that needs to be verified. |
| DOCUMENT_ID | A unique document identifier is data that needs to be verified. |
| DOCUMENT_PHOTO | The data that needs to be verified is document photo. |
| BUSINESS_VALIDATION | Bussinees data needs to be verified. |
| PERSONAL_SANCTION_LIST | Input value is PSL check. |
| BUSINESS_SANCTION_LIST | The data that needs to be verified are related to Business Sanction List. |
| PERSONAL_PEP | The data that needs to be verified are related to Personal Politically Exposed Person. |
| DOCUMENT_FORGERY | The data that needs to be verified are related to document forgery. |
| BANK_ID | A unique bank identifier is data that needs to be verified. |
| BANKING_API | The data that needs to be verified is banking API. |
| PERSONAL_ADVERSE_MEDIA | The data that needs to be verified are related to Personal Adverse Media. |
| BUSINESS_ADVERSE_MEDIA | The data that needs to be verified are related to Business Adverse Media. |
| BUSINESS_PEP | The data that needs to be verified are related to Business Politically Exposed Person (PEP). |
| MONITORING_BUSINESS_PEP | The data that needs to be verified are related to Monitoring Business PEP. |
| MONITORING_BUSINESS_SANCTIONS | The data that needs to be verified are related to Monitoring Business Sanctions. |
| MONITORING_BUSINESS_ADVERSE_MEDIA | The data that needs to be verified are related to Monitoring Business Adverse Media. |
| MONITORING_PERSONAL_PEP | The data that needs to be verified are related to Monitoring Personal PEP. |
| MONITORING_PERSONAL_SANCTIONS | The data that needs to be verified are related to Monitoring Personal Sanctions. |
| MONITORING_PERSONAL_ADVERSE_MEDIA | The data that needs to be verified are related to Monitoring Personal Adverse Media. |
| NONE | The data that needs to be verified are not predefined. |
CompanyStatus
Values
| Value | Description |
|---|---|
| APPLIED | The company is registered on the platform; waiting on review and activation by the system administrator. |
| ACTIVE | The company information are reviewed and the company is successfully activated by the system administrator. |
| PAUSED | The user can log into the system, but will not be able to create and run sessions. |
| DECLINED | If the information entered during the registration are incorrect or the company is suspicious for any reason, the system or company administrator changes the company status to Declined. The user will not be able to log into the system. |
| SUSPENDED | The company is temporarily suspended by the system or company administrator. |
| CANCELED | The company is canceled by the system or company administrator. The user cannot log into the system as the company account is canceled. |
DocumentType
Values
| Value | Description |
|---|---|
| PASSPORT | The type of document used for verification is a passport. |
| DRIVER_LICENCE | The type of document that will be used for verification is a driver's licence. |
| MEDI_CARD | The medical card is the type of document that will be used for verification. |
| IMMI_CARD | The immigration card is the type of document that will be used for verification. |
| CREDIT_CARD | The type of document used for verification is a credit card. |
| BANK_STATEMENT | The input data for the document type is bank statement data. |
| UTILITY_BILL | The type of document used for verification is utility bills. |
| ID_CARD | The type of document used for verification is a unique card identifier. |
| CUSTOM | The type of document used for verification is custom data. |
FieldSetCategory
Values
| Value | Description |
|---|---|
| PERSONAL | Field to enter personal data. |
| LOCATION | Field to enter location information. |
| ADDRESS | Field to enter address information. |
| COMMUNICATION | Field to enter type of communication (e-mail, phone, social networks) information. |
| PASSPORT | Field to enter passport information. |
| DRIVER_LICENCE | Field to enter driver's licence information. |
| MEDI_CARD | Field to enter medical card data. |
| IMMI_CARD | Field to enter immigration card information. |
| CREDIT_CARD | Field to enter credit card information. |
| BANK_STATEMENT | Field to enter bank statement data. |
| UTILITY_BILL | Field to enter utility bill information. |
| ID_CARD | Field to enter card identifier information. |
| CUSTOM | Field to enter custom information. |
Permission
Values
| Value | Description |
|---|---|
| USER | Company user accounts permissions and level of access to the platform. |
| MANAGER | Manager's accounts permissions and level of access to the platform. |
| ADMIN | System administrator's account permissions and level of access to the platform. |
| SYSTEM_READ | User with permission to read system data. |
| SYSTEM_MANAGE | Which user has permission to manage system data? |
| ALL_COMPANIES_READ | Which user has permission to read all company's data? |
| ALL_COMPANIES_MANAGE | Which user has permission to manage all company's data? |
| PROVIDER_READ | Which user has permission to read the provider's data? |
| PROVIDER_MANAGE | Which user has permission to manage provider's data? |
| PROVIDER_PRICING_READ | Which user has permission to read provider pricing data? |
| PROVIDER_PRICING_MANAGE | Which user has permission to manage provider pricing data? |
| PRODUCT_READ | Which user has permission to read product data? |
| PRODUCT_MANAGE | Defines which user has permission to manage product data. |
| PURCHASE_READ | Defines which user has permission to read purchase data. |
| PURCHASE_CREATE | Defines which user has permission to create purchase data. |
| PURCHASE_MANAGE | Defines which user has permission to manage purchase data. |
| COMPANY_CHECK_READ | Defines which user has permission to read company check data. |
| COMPANY_CHECK_MANAGE | Defines which user has permission to manage company check data. |
| COMPANY_READ | Defines which user has permission to manage company data. |
| COMPANY_MANAGE | Defines which user has permission to manage company data. |
| USER_READ | Defines which user has permission to read the user's data. |
| USER_MANAGE | Defines which user has permission to manage the user's data. |
| CONFIGURATION_READ | Defines which user has permission to read configuration data. |
| CONFIGURATION_MANAGE | Defines which user has permission to manage configuration data. |
| COMPANY_CHECK_PRICING_READ | Defines which user has permission to read company check pricing data. |
| CONFIGURATION_PRICING_READ | Defines which user has permission to read company configuration pricing data. |
| CONFIGURATION_PRICING_MANAGE | Defines which user have permission to manage company configuration pricing data. |
| COMPANY_CHECK_PRICING_MANAGE | Defines which user has permission to manage company check pricing data. |
| SESSION_READ | Defines which user has permission to read session data. |
| SESSION_CREATE | Defines which user has permission to create session data. |
| SESSION_CANCEL | Defines which user has permission to cancel session data. |
| CHECK_RESULT_READ | User with permission to read check results data. |
| CHECK_RESULT_FLAGGING | User with permission to flag check results data. |
| REPORTING_AGGREGATED_READ | User with permission to read aggregated reporting data. |
| REPORTING_READ | User with permission to read reporting data. |
| X_RAY_PROVIDER_READ | User that has permission to read XRAY provider data. |
| X_RAY_PROVIDER_MANAGE | User that has permission to manage XRAY provider data. |
| API_AUTHENTICATE | User that has permissions for API authentication. |
ResponseTransport
Values
| Value | Description |
|---|---|
| WEBHOOK | Response returns to specified Webhook. |
| AZURE_SERVICE_BUS | Response is redirected to Azure Service Bus message broker. |
| REDIS_PUB_SUB | Response is redirected to Redis Pub Sub message transport service. |
| RABBIT_MQ | Response is redirected to Rabbit MQ Listener. |
| LONG_POLLING | Waiting for response. |
| Response is sent to predefined e-mail address. | |
| DEV_NULL | No action needed. |
SessionStatus
Values
| Value | Description |
|---|---|
| CREATED | Initial status - will never be presented to end user in this state. |
| READY | Internal status - will never be presented to end user in this state. |
| PROCESSING | Session is fetching and processing results. |
| DONE | Session that received result and its execution is completed. |
| ONGOING | Monitoring session that received initial data but can be updated in the future. |
SourceType
Values
| Value | Description |
|---|---|
| PERSON | Personal information. |
| BUSINESS | Business information. |
| BUSINESS_WITH_PERSONS | A founder, owner, investor or majority shareholder of a private sector information. |
StatsMetric
Values
| Value | Description |
|---|---|
| NO_METRIC | Statistical metric values are not defined. |
| DAY | The value of the statistical metric is day. |
| MONTH | The value of the statistical metric is month. month. |
| YEAR | The value of the statistical metric is year. |
| COMPANY | The value of the statistical metric is company. |
| SESSION | The value of the statistical metric is session. |
| SESSION_CHECK | The value of the statistical metric is session check. |
| COMPANY_CHECK | The value of the statistical metric is company check. |
| CONFIGURATION | The value of the statistical metric is configuration. |
ValueType
Values
| Value | Description |
|---|---|
| STRING | The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. |
| INT | The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| DATE_TIME | The DateTime scalar represents an ISO-8601 compliant date time type. |