> ## Documentation Index > Fetch the complete documentation index at: https://api.amlyze.com/llms.txt > Use this file to discover all available pages before exploring further. # Simplified customer import > This section provides information on how to generate a Simplified Customer for individuals or organizations. ## OpenAPI ````yaml /api/openapi_api_adapter.json post /amlyze-ws-rest/simplifiedCustomer openapi: 3.1.0 info: title: OpenAPI definition version: v0 servers: - url: https://{{baseUrl}} description: Generated server url security: - bearerAuth: [] tags: [] paths: /amlyze-ws-rest/simplifiedCustomer: post: tags: - simplified-customer summary: Simplified customer import description: >- This section provides information on how to generate a Simplified Customer for individuals or organizations. operationId: postCustomer requestBody: content: application/json: schema: $ref: '#/components/schemas/SimplifiedCustomerApi' examples: individual_mandatory: summary: Simplified customer import - Individual (Mandatory fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: AMLYZE_TEST businessUnit: sandbox riskManagementCategory: IND_OCCASIONAL entityType: INDIVIDUAL customerExtId: IND20231117538 firstName: Tony lastName: Mikelangelo individual_with_screening: summary: >- Simplified customer import - Individual with screening (Mandatory fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: AMLYZE_TEST businessUnit: sandbox riskManagementCategory: IND_OCCASIONAL entityType: INDIVIDUAL customerExtId: IND20231117538 firstName: Tony lastName: Mikelangelo initializeScreeningProcesses: - SANCTIONS - ADVERSE_MEDIA - PEP - INTERNAL_LIST organization_mandatory: summary: Simplified customer import - Organization (Mandatory fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: SYSTEMX businessUnit: sandbox riskManagementCategory: IND_OCCASIONAL entityType: ORGANIZATION customerExtId: ORG20231117550 title: UAB 'BrotherHood' organization_with_screening: summary: >- Simplified customer import - Organization with screening (Mandatory fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: SYSTEMX businessUnit: sandbox riskManagementCategory: IND_OCCASIONAL entityType: ORGANIZATION customerExtId: ORG20231117550 title: UAB 'BrotherHood' initializeScreeningProcesses: - SANCTIONS - ADVERSE_MEDIA - PEP - INTERNAL_LIST organization_mandatory_with_risk_assessment: summary: Organization with risk assessment (Mandatory fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: SYSTEMX businessUnit: sandbox sourceOfRiskLevel: EVALUATE riskManagementCategory: ORG entityType: ORGANIZATION customerExtId: ORG_IMPORT_B1_TEST applicationDate: '2016-01-01' title: LTD 'VivaElementus' registrationCountry: LV legalForm: CORPORATION organization_with_risk_assessment_and_screening: summary: >- Organization with risk assessment and screening (Mandatory fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: SYSTEMX businessUnit: sandbox sourceOfRiskLevel: EVALUATE riskManagementCategory: ORG entityType: ORGANIZATION customerExtId: ORG_IMPORT_B1_TEST applicationDate: '2016-01-01' title: LTD 'VivaElementus' registrationCountry: LV legalForm: CORPORATION initializeScreeningProcesses: - SANCTIONS - ADVERSE_MEDIA - PEP - INTERNAL_LIST individual_all_fields: summary: Individual with risk assessment (All fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: example businessUnit: sandbox riskManagementCategory: IND_OCCASIONAL riskLevel: HIGH customerStatus: CLOSED entityType: INDIVIDUAL customerExtId: IND20231113T18099 applicationDate: '2016-01-01' firstName: Jose lastName: Rodriguez initializeScreeningProcesses: - SANCTIONS - ADVERSE_MEDIA - PEP - INTERNAL_LIST citizenshipCountry: LT birthDate: '1990-01-01' approvalDate: '2016-01-01' closingDate: '2023-01-01' birthCountry: LV placeOfBirth: Vilnius nationalCode: '123456789123' secondCitizenshipCountry: LV permanentResidenceCountry: LT isLegalResident: true isPEP: true isSanctioned: false isInAdverseMedia: true isInInternalList: true isFamilyPEP: true isLitigated: true amlOfficer: true listPurpose: BLACK isActualAddressDeclared: true isCorrespondenceAddressDeclared: false activityDescription: financial activity incomeSourceDescription: Dividends initialDepositSource: Salary initialDepositBank: LB initialDepositAccount: LV45547888441236 initialDepositAmount: 5000 initialDepositCurrency: EUR doesCashDominate: false listContact: - contactType: MOBILEPHONE contactDetails: +370 68* ***** useForCommunication: true - contactType: EMAIL contactDetails: customer64@example.com useForCommunication: true listAddress: - addressDetails: Verkiu g. 1/5 addressType: RESIDENCE city: Vilnius country: LT region: EU streetAddress: Verkiu g. useForCorrespondence: true zipCode: '04127' listBusinessEntityDocument: - entityType: INDIVIDUAL identityDocumentType: PASSPORT documentNumber: '123456789' documentIssueDate: '2020-09-20' documentExpiryDate: '2030-09-20' documentIssueCountry: LT documentIssueAuthority: LT description: identification document organization_all_fields: summary: Organization with risk assessment (All fields) value: communicationNumber: 1b1e1c23-f62f-4338-90b9-8d54993dd2cd requester: example businessUnit: sandbox riskManagementCategory: IND_OCCASIONAL riskLevel: EXTREME customerStatus: ACTIVE entityType: ORGANIZATION customerExtId: ORG20231117550 applicationDate: '2012-10-01' title: UAB 'BrotherHood' initializeScreeningProcesses: - SANCTIONS - ADVERSE_MEDIA - PEP - INTERNAL_LIST registrationCountry: LT legalForm: CORPORATION approvalDate: '2016-01-01' establishmentDate: '2010-10-01' nationalCode: '123456789' activityDescription: Financial activity activityInRestrictedRegionDescription: logistics isSanctioned: false isInAdverseMedia: true isInInternalList: true isPEP: false giin: GIIN123445 lei: LEI124545 isActualAddressDeclared: true isCorrespondenceAddressDeclared: false incomeSourceDescription: Salary initialDepositSource: Dividends initialDepositBank: BankBank initialDepositAccount: LV445788745120002 initialDepositAmount: 10000 initialDepositCurrency: EUR doesCashDominate: true isAudited: true numberOfAudits: 2 periodsOfAuditsInYears: 1 organizationalStructureDescription: Hierarchical hasMultiLayerStructure: false isFinancialInstitution: false isDirectlyManaged: true noMajorShareHolders: true numberOfEmployees: 321 companyAssetValue: 5500000 isFined: false periodsOfFiningInYears: 0 isListed: false isRegulated: false isLicenseRequired: true licenseDescription: LicenceNo:LV57.144 listPurpose: WHITE closingDate: '2005-05-24' isLitigated: false thirdPartyServicesUsed: true thirdPartyServicesUsedDescription: hosting regionOfActivityDescription: Central Europe listAddress: - addressType: HEADQUARTERS addressDetails: 19/2 country: LT region: EU city: Vilnius streetAddress: vilniaus g. zipCode: '04578' useForCorrespondence: true listBusinessEntityDocument: - entityType: ORGANIZATION identityDocumentType: REGISTRATIONCERTIFICATE documentNumber: D0KN045454545 documentIssueDate: '2017-08-20' documentExpiryDate: '2027-08-20' documentIssueCountry: LT documentIssueAuthority: Federal Tax Service description: Main identification document listContact: - contactType: EMAIL contactDetails: Customermail@yahoo.com useForCommunication: true - contactType: MOBILEPHONE contactDetails: +350487254** useForCommunication: true required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ResultApi' '400': description: >- Bad Request. The request is invalid, e.g., a mandatory field is missing or a value is incorrect. content: application/json: schema: $ref: '#/components/schemas/ApiAdapterErrorResponse' example: resultType: REQUEST_REJECTED errorCode: O001 errorDescription: CommunicationNumber already used in AMLYZE '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ApiAdapterErrorResponse' example: timestamp: '2024-05-26T16:49:50.237+00:00' status: 404 error: Not Found path: /amlyze-ws-rest/simplifiedCustomer '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiAdapterErrorResponse' example: resultType: REQUEST_REJECTED status: 500 error: Internal Server Error components: schemas: SimplifiedCustomerApi: properties: activityDescription: description: Description of entity activity. example: Financial activity maxLength: 32768 type: string activityInRestrictedRegionDescription: description: Description of entity activity. maxLength: 32768 type: string amlOfficer: description: Whether the person is an AML officer. type: boolean applicationDate: description: Date when customer first applied. format: date type: string approvalDate: description: Date of application approval - onboarding date. format: date type: string birthCountry: dependentRequired: entityType: - INDIVIDUAL description: Country of birth of the individual entity. type: string birthDate: dependentRequired: entityType: - INDIVIDUAL description: Date of birth of the individual entity format: date type: string businessUnit: description: >- Mandatory field for clients utilizing a multi-organizational solution. It serves to specify the unique identifier for the business unit. type: string citizenshipCountry: description: Country of citizenship of individual entity. type: string closingDate: description: >- ❗Mandatory only when customerStatus = `CLOSED`. Not used when `customerStatus` is `PENDING`, `ACTIVE`, `REJECTED` or `SUSPENDED`. format: date type: string communicationNumber: description: >- Unique number of communication. It is used for risk assessment callback. maxLength: 255 type: string companyAssetValue: description: Value of the company's assets. type: integer customerExtId: description: >- Unique external customer identifier. This identifier corresponds to the client's identifier in the financial institution. example: 019a5d1b-8c4f-770b-ad70-2f2a6c88aeda type: string customerStatus: description: >- Customer's predefined status represents the current standing or state of a customer's relationship with a business or organization. - `PENDING` - Customer application is received but not yet prepared for upcoming workflow - `ACTIVE` - Customer is onboarded and ready for workflow - `REJECTED`- the customer was rejected before account was opened - `SUSPENDED` - Customer's activities for some reasons are restricted - `CLOSED` - Customer's profile is disabled enum: - ACTIVE - CLOSED - PENDING - REJECTED - SUSPENDED type: string doesCashDominate: description: Whether cash is the main income source. type: boolean entityType: description: >- Type of the customer. `INDIVIDUAL` represents a natural person; `ORGANIZATION` represents a legal entity such as a company, partnership, or foundation. ❗ This value drives conditional field requirements: - `INDIVIDUAL` requires `firstName`, `lastName` - `ORGANIZATION` requires `title` Fields specific to the other entity type are not allowed. See each affected field's description for its individual constraint. enum: - INDIVIDUAL - ORGANIZATION type: string establishmentDate: description: Date of establishment of the organization. format: date type: string firstName: dependentRequired: entityType: - INDIVIDUAL description: |- First name of the individual. ❗ This field is mandatory when entityType is `INDIVIDUAL`. type: string giin: description: Global intermediary identification number. type: string hasMultiLayerStructure: description: Whether the entity has a multi-layer organizational structure. type: boolean incomeSourceDescription: description: Description of income source. maxLength: 32768 type: string incomingPaymentDescription: description: Description of incoming payment operation. type: string initialDepositAccount: description: Account of initial deposit. maxLength: 200 type: string initialDepositAmount: description: Initial deposit amount. format: double type: number initialDepositBank: description: Bank of initial deposit. maxLength: 200 type: string initialDepositCurrency: description: Initial deposit currency. Taken from /classifier/currency endpoint. type: string x-dynamic-enum: path: /classifier/currency valueField: code initialDepositSource: description: Source of initial deposit. maxLength: 200 type: string initializeScreeningProcesses: description: Defines which lists to check during screening process. items: type: string enum: - SANCTIONS - PEP - ADVERSE_MEDIA - INTERNAL_LIST type: array isActualAddressDeclared: description: Whether entity's actual address is declared. type: boolean isAudited: description: Whether the business entity is audited. type: boolean isCorrespondenceAddressDeclared: description: Whether entity's correspondence address is declared. type: boolean isDirectlyManaged: description: Whether entity is managed directly. type: boolean isFamilyPEP: description: Whether a family member of the individual is politically exposed. type: boolean isFinancialInstitution: description: Whether entity is a financial institution. type: boolean isFined: description: Whether the business entity is fined. type: boolean isInAdverseMedia: description: Whether there is adverse-media information about the entity. type: boolean isInInternalList: description: Whether there is internal-list information about the entity. type: boolean isLegalResident: description: Whether the individual is a legal resident. type: boolean isLicenseRequired: description: Whether the entity's activity requires a license. type: boolean isListed: description: Whether the business entity is listed on a stock exchange. type: boolean isLitigated: description: Whether the customer is involved in litigation. type: boolean isPEP: description: Whether the entity is politically exposed. type: boolean isRegulated: description: Whether the business entity is regulated by third-party authorities. type: boolean isSanctioned: description: Whether the entity is sanctioned. type: boolean lastName: dependentRequired: entityType: - INDIVIDUAL description: |- Last name of the individual. ❗ This field is mandatory when entityType is `INDIVIDUAL`. type: string legalForm: description: Legal form of the organization. type: string lei: description: >- LEI stands for Legal Entity Identifier, which is a unique code used to identify legal entities that participate in financial transactions. type: string licenseDescription: description: Business entities license description. maxLength: 32768 type: string listAddress: description: List of addresses. items: $ref: '#/components/schemas/AddressApi' type: array listBusinessEntityDocument: description: List of business entity documents. items: $ref: '#/components/schemas/BusinessEntityDocumentApi' type: array listContact: description: List of contacts. items: $ref: '#/components/schemas/ContactApi' type: array listPurpose: description: |- Indicates whether the entity is on a risk-management list. - `WHITE` - Entity is allow-listed. - `BLACK` - Entity is block-listed. enum: - BLACK - WHITE type: string nationalCode: description: >- National code or national identification number of individual. If a country does not issue national code, any other unique identifier can be used: Passport number, Social security number of person, A number of taxpayer or registration certificate of the company, etc. maxLength: 100 type: string noMajorShareHolders: description: Whether entity has no major shareholders involved. type: boolean numberOfAudits: description: The number of times a business entity has been audited. type: integer numberOfEmployees: description: Number of employees. type: integer organizationalStructureDescription: description: Description of organizational structure. maxLength: 32768 type: string periodsOfAuditsInYears: description: The number of years that are in question for being audited. type: integer periodsOfFiningInYears: description: The number of years that are in question for being fined. type: integer placeOfBirth: dependentRequired: entityType: - INDIVIDUAL description: Place of birth of individual entity. type: string regionOfActivityDescription: description: Description of the region for activities. maxLength: 32768 type: string registrationCountry: description: >- Country of registration of organization entity. Value taken from /classifier/country endpoint. type: string x-dynamic-enum: path: /classifier/country valueField: code requester: description: Name of the system requesting web service. maxLength: 100 type: string riskLevel: description: Predefined risk level of imported customer. enum: - EXTREME - HIGH - LOW - MEDIUM - NONE type: string riskManagementCategory: description: >- Code of risk management category of the object. Value must be from a classifier list personalized to your company. type: string sourceOfRiskLevel: description: >- The value `EVALUATE` is used for initiating a customer risk assessment. The value `IMPORT` should be used for migration only - the customer and it's questionnaire will be imported without risk assessment. enum: - EVALUATE - IMPORT type: string thirdPartyServicesUsed: description: Whether the entity uses third-party services. type: boolean thirdPartyServicesUsedDescription: description: Description of third-party services used by entity. maxLength: 32768 type: string title: description: |- Title (official name) of the organization. ❗ This field is mandatory when entityType is `ORGANIZATION`. type: string required: - communicationNumber - customerExtId - customerStatus - entityType - requester - riskManagementCategory type: object ResultApi: properties: errorCode: type: string errorDescription: type: string resultType: enum: - REQUEST_ACCEPTED - REQUEST_REJECTED type: string type: object ApiAdapterErrorResponse: properties: errorCode: type: string errorDescription: type: string resultType: type: string errors: type: array items: type: string timestamp: type: string status: type: number error: type: string path: type: string AddressApi: description: List of addresses. properties: addressDetails: description: Full address description. example: Building B. maxLength: 255 type: string addressType: description: >- Type of entity address. Value is taken from /classifier/addressType endpoint. type: string x-dynamic-enum: path: /classifier/addressType valueField: code city: description: City of the given address. example: Vilnius maxLength: 100 type: string country: description: >- Country of the given address. Mandatory only when `listAddress` is provided. example: LT type: string x-dynamic-enum: path: /classifier/country valueField: code region: description: >- Region of the given address. Value is taken from /classifier/country endpoint with indicator `isRegion=true`. example: EU type: string x-dynamic-enum: path: /classifier/country valueField: code streetAddress: description: Street address of the given address. maxLength: 255 type: string useForCorrespondence: description: Whether the address is used for correspondence. type: boolean zipCode: description: Zip code of the address. maxLength: 50 type: string required: - addressType type: object BusinessEntityDocumentApi: description: List of business entity documents. properties: description: description: A description of the document. maxLength: 400 type: string documentExpiryDate: description: The expiry date of the document in question. format: date type: string documentIssueAuthority: description: >- An authority that issued the document. Mandatory only when `listBusinessEntityDocument` is provided. maxLength: 100 type: string documentIssueCountry: description: >- The country that issued the document. Value is taken from `/classifier/country` endpoint. Mandatory only when `listBusinessEntityDocument` is provided. type: string x-dynamic-enum: path: /classifier/country valueField: code documentIssueDate: description: >- The issue date of the document in question. Mandatory only when `listBusinessEntityDocument` is provided. format: date type: string documentNumber: description: >- The number of the document in question. Mandatory only when `listBusinessEntityDocument` is provided. type: string entityType: description: >- Type of the entity that this document attaches to. `INDIVIDUAL` represents a natural person; `ORGANIZATION` represents a legal entity such as a company, partnership, or foundation; `UNKNOWN` represents a party whose type has not yet been classified. Mandatory only when `listBusinessEntityDocument` is provided. enum: - INDIVIDUAL - ORGANIZATION - UNKNOWN type: string identityDocumentType: description: >- Identification document type. Mandatory only when `listBusinessEntityDocument` is provided. enum: - DRIVINGLICENSE - IDENTITYCARD - OTHER - PASSPORT - REGISTRATIONCERTIFICATE - RESIDENCEPERMIT type: string required: - description - documentIssueAuthority - documentIssueCountry - documentIssueDate - documentNumber - entityType - identityDocumentType type: object ContactApi: description: List of contacts. properties: contactDetails: description: Details of contact. Mandatory only when `listContact` is provided. example: example@example.com type: string contactType: description: >- Way of contacting entity. Mandatory only when `listContact` is provided. enum: - EMAIL - FIXEDPHONE - MOBILEPHONE - WEBSITE type: string x-dynamic-enum: path: /classifier/contactType valueField: code useForCommunication: description: Whether the contact is used for communication. type: boolean required: - contactDetails - contactType type: object securitySchemes: bearerAuth: type: http scheme: bearer ````