Authentication
Before you can integrate with the AML AI API, you must set up your development environment and get your API key.For more details please read the : Authentication section.
We keep our technical documentation here: SWAGGER API
(add to header)
Parameter Name: api-key
Parameter Value: deticated api-key
customer-checks-controller
Perform checks on a customer
Code samples
POST /v1/customerChecks
Body parameter
For example request body file please visit: Customer Checks
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GatewayCustomerChecks | true | Request body for Customer Check |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Customer successfully checked | CustomerResponse |
| 201 | Created | Created | None |
| 202 | Accepted | Successfully started with Customer Checks but immediate decision is not available yet. Do not retry and wait for processing to complete. A callback will be sent once processing is complete | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
| 425 | Too Early | "Too early. Please do not send yet this customer. Try again later." - Requests for the same customer need to be at least 1 sec apart to ensure data is stored properly in the system before new request arrives | None |
Schemas
For the most recent detailed schema description please visit:
Swagger Documentation
Characteristics
{
"customerSince": "2020-05-16",
"depositDelay": "7d",
"discountFrequency": "WEEKLY",
"entryModeDistribution": [
{
"labels": [
"MAGNETIC_STRIPE"
],
"share": 0.75
}
],
"expectedIncomeDaily": 45000,
"expectedIncomeMonthly": 110000,
"expectedIncomeYearly": 150000,
"expectedTicketSizeAverage": 127.45,
"expectedTicketSizeMax": 20000,
"expectedTransactionCountDaily": 5000,
"expectedTransactionCountMonthly": 50000,
"expectedTransactionCountYearly": 500000,
"expectedVolumeDaily": 50000,
"expectedVolumeMonthly": 150000,
"expectedVolumeVolatility": "SEASONAL"
}
Characteristics
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customerSince | string | false | none | Date when the customer was created. Provided in UTC at any precision available: YYYY, YYYY-MM, YYYY-MM-DD or timestamp in ISO format YYYY-MM-DDThh24:mi:ss. Examples: -2019 -2019-10 -2019-10-16 -2019-10-16T14:38:47 |
| depositDelay | string | false | none | Delay of availability of deposited funds. Can be numeric (suffix 'd' for days) or categoric (reach out if categoric values are required). |
| discountFrequency | string | false | none | Frequency of discount. Examples: - DAILY - WEEKLY - MONTHLY - QUARTERLY |
| entryModeDistribution | [Distribution] | false | none | Expected contribution over channels. |
| expectedIncomeDaily | number(double) | false | none | Expected daily income (cashflow positive volume) in configured base currency |
| expectedIncomeMonthly | number(double) | false | none | Expected monthly income (cashflow positive volume) in configured base currency |
| expectedIncomeYearly | number(double) | false | none | Expected income volume per year in configured base currency. |
| expectedTicketSizeAverage | number(double) | false | none | Expected avg ticket size in configured base currency |
| expectedTicketSizeMax | number(double) | false | none | Max ticket size expected |
| expectedTransactionCountDaily | number(double) | false | none | Expected count of transactions per day |
| expectedTransactionCountMonthly | number(double) | false | none | Expected count of transactions per month |
| expectedTransactionCountYearly | number(double) | false | none | Expected count of transactions per year |
| expectedVolumeDaily | number(double) | false | none | Expected daily volume ( |
| expectedVolumeMonthly | number(double) | false | none | Expected monthly volume ( |
| expectedVolumeVolatility | string | false | none | Volatility of the volume. Examples: - SEASONAL - STABLE - YEAR_END_SEASON - ... (reach out for additional values) |
CompanyDetails
{
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"businessDescription": "Specialized on elderly women",
"businessPurposes": [
"5065",
"5085"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"companyDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"businessDescription": "Specialized on elderly women",
"businessPurposes": [
"5065",
"5085"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [],
"staff": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "München",
"webLinks": [
"https://aml-ai.tech",
"https://linkedin.com"
],
"zip": "81737"
},
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"id": "F8624KW3J6",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "string"
}
]
},
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "München",
"webLinks": [
"https://aml-ai.tech",
"https://linkedin.com"
],
"zip": "81737"
},
"liability": "PERSONAL",
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"id": "F8624KW3J6",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "string",
"share": 0.51
}
],
"staff": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "München",
"webLinks": [
"https://aml-ai.tech",
"https://linkedin.com"
],
"zip": "81737"
},
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"id": "F8624KW3J6",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "string"
}
]
}
CompanyDetails
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| assessments | [Assessment] | false | none | List of assessments or scorings that have been conducted |
| businessDescription | string | false | none | Free text describing the business |
| businessPurposes | [string] | false | none | List of business purposes of the company (ISO-18245 merchant category codes) |
| companyId | string | false | none | Id that helps referencing back the company information to the system from which the information is originated. |
| companyName | string | false | none | Name of the company according to comercial register |
| countryOfRegistration | string | false | none | Country where the company was originally founded and registered (ISO 3166-1 alpha-2). |
| division | string | false | none | Tenants's company division or department contractually involved |
| inBusinessSince | string | false | none | In business since |
| legalForm | string | false | none | Legal form of the company (ISO-20275/ELF Code). |
| organizationType | string | false | none | Type of organization. Examples: - GOVERNMENTAL - FOR_PROFIT - NON_PROFIT - ... (reach out to request more values) |
| shareholders | [Shareholder] | false | none | List of shareholders/owners of the company/organization. |
| staff | [StaffMember] | false | none | List of the managing directors of the company/organization. |
PersonalDetails
{
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"id": "F8624KW3J6",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
}
PersonalDetails
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| assessments | [Assessment] | false | none | List of assessments or scorings that have been conducted |
| countryOfBirth | string | false | none | Country where the customer was born. |
| countryOfResidence | string | false | none | Country where the customer currently lives. |
| dateOfBirth | string | false | none | Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only) |
| gender | string | false | none | Gender: 'f' (female), 'm' (male) or 'x' (other) |
| identityDocuments | [IdentityDocument] | false | none | List of documents that identify a person |
| nationality | string | false | none | Nationality of the individual customer. |
| personName | PersonName | false | none | none |
| placeOfBirth | string | false | none | City/place where the customer was born. |
| socialSecurityNumber | string | false | none | Social security number |
ContactDetails
{
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "München",
"webLinks": [
"https://aml-ai.tech",
"https://linkedin.com"
],
"zip": "81737"
}
ContactDetails
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addressValidSince | string | false | none | Date since the given postal address is valid. Provide date |
| allAssignedCustomerIds | [string] | false | none | List of all customer ids that are representing this account holder. |
| contactId | string | false | none | Id that helps referencing the contact information back to the system from which the data originates |
| contactName | string | false | none | Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise. |
| contactNameExtended | string | false | none | Extension of the name line if required |
| country | string | false | none | Country of the contact address of the individual or company/organization |
| emailAddresses | [string] | false | none | List of email addresses on which the customer can be reached. |
| phoneNumbers | [string] | false | none | List of phone numbers on which the customer can be reached. |
| region | string | false | none | Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2) |
| regionExtended | string | false | none | Extension field for region (e.g. county) |
| street | string | false | none | Street (incl. number if applicable) |
| streetExtended | string | false | none | Possible extention of the street line in the address block. Provide if required. |
| town | string | false | none | City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company. |
| webLinks | [string] | false | none | List of web links/urls to representations of the company or person in the internet or intranet |
| zip | string | false | none | Postal code of contact address of the individual or company |
CustomerRelationshipDetails
{
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"countryOfSettlement": "NL",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
CustomerRelationshipDetails
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allAcounts | [AccountForRelationshipDetails] | false | none | List of accounts for relationship |
| businessUnit | string | false | none | Name of the business unit the customer is assigned to |
| staff | [StaffMember] | false | none | List of staff members |
StaffMember
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123" ],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com" ],
"phoneNumbers": [
"+4915178859632",
"+4915178858526" ],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "München",
"webLinks": [
"https://aml-ai.tech",
"https://linkedin.com" ],
"zip": "81737" },
"personalDetails": {
"assessments": [ {
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE" } ],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [ {
"id": "F8624KW3J6",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport" } ],
"nationality": "BE",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate" },
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112" },
"role": "string"}
StaffMember
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactDetails | ContactDetails | false | none | none |
| personalDetails | PersonalDetails | false | none | none |
| role | string | false | none | Role of the staffer. No need to provide the exact role name. Categorize into what makes sense from an AML perspective. Examples: - MANAGER - ... (reach of for further values) |
AccountForRelationship
{
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"countryOfSettlement": "NL",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
AccountForRelationship
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountEmailId | string | false | none | Email address that uniquely identifies the account within the scheme (e.g. for PayPal) |
| accountId | string | false | none | Id that identifies the account uniquely within the scheme or the sending sending tenant. E.g. - merchant ID (MID) for credit card schemes - tokenized card number if it is unique within the tenant |
| accountNumber | string | false | none | Account number that identifies the account uniquely withing the scheme along with other account details, if the scheme provides such an account number (e.g. IBAN, national account number). |
| bankCountry | string | false | none | Country of the bank or financial insitution (ISO 3166 Alpha-2) |
| bankIdentifier | string | false | none | The bank identification code (BIC). |
| countryOfSettlement | string | false | none | Country that has been designated settle transactions for this account holder |
| expiry | string | false | none | Expiry month of the account details .E.g. expiry data for credit cards. |
| holder | string | false | none | The full name of the owner of the bank account with middle name, format: First Name, Middle Name, Last Name. |
| Last4Digits | string | false | none | Last for digits of the account number if the full account number cannot be provided.E.g. for credit card payments |
| productCode | string | false | none | Code of the product used to facilitate the payment (as provided by the scheme operator) See here for examples of such product codes - Visa Product Id - Master/VISA product codes Examples: - BPD (MASTER Business Premium DEBIT) - P (Visa Gold) - WIC (EBT woman, infants, children ) - FOOD_STAMP - ... |
| productType | string | false | none | Type of the product or service. Examples: - CHECKING_ACCOUNT - CREDIT_CARD - DEBIT_CARD - PREPAID_CARD - GIRO_ACCOUNT - CHECKING_ACCOUNT - SAVINGS_ACCOUNT - STORED_VALUE_CARD - TERM_ACCOUNT - BASIS_ACCOUNT (as GIRO_ACCOUNT without the possibility to overdraft) - VOUCHER (women, infants, children as part of EBT scheme), - ... (reach out if additional values are required) |
| schema | string | false | none | Scheme or processing network within the account details uniquely identify an account. Country code for national banking schemes (ISO 3166 Alpha-2). Examples: - AMEX - CARD_MERCHANTACCOUNT (for merchant accounts accepting card payments) - CITI - DE - DISCOVER - GB - JCB - MAESTRO - MASTER - SEPA - SOLO - SWITCH - US - UNIONPAY - VISA - ... (reach out if additional values are required) |
GatewayCustomerChecks
{
"callbackUrl": "https://callback.url/1234",
"customerReviewSchedule": {
"nextReviewDate": "2023-12"
},
"masterData": {
"accountHoldingPartyData": {
"accountReplaced": true,
"accountReplacedNotes": "Chargeback rate exceeded",
"characteristics": {
"businessPurposeDistribution": [
{
"labels": [
"MAGNETIC_STRIPE"
],
"share": 0.75
}
],
"depositDelay": "7d",
"discountFrequency": "WEEKLY",
"employmentDetails": {
"status": "EMPLOYED"
},
"entryModeDistribution": [
{
"labels": [
"MAGNETIC_STRIPE"
],
"share": 0.75
}
],
"expectedIncomeDaily": 45000,
"expectedIncomeMonthly": 110000,
"expectedIncomeYearly": 150000,
"expectedTicketSizeAverage": 127.45,
"expectedTicketSizeMax": 20000,
"expectedTransactionCountDaily": 5000,
"expectedTransactionCountMonthly": 50000,
"expectedTransactionCountYearly": 500000,
"expectedVolumeDaily": 50000,
"expectedVolumeMonthly": 150000,
"expectedVolumeVolatility": "SEASONAL",
"expectedVolumeYearly": 150000,
"majorCounterpartyAccounts": [
{
"accountClosureDate": "2021-01-02",
"accountEmailId": "harles.hollinten@mail.com",
"accountId": 435863453,
"accountNumber": "DE12500105170648489890",
"accountOpeningDate": "2021-01-01",
"accountStatus": "open",
"accountType": "checking account",
"attributes": [
"PND account"
],
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"bankName": "STADTSPARKASSE MUENCHEN",
"currency": "BTC",
"expiry": 202911,
"holder": "John Smith",
"last4Digits": 435863453,
"location": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"overdraftLimit": 500,
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
]
}
]
},
"companyDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"businessDescription": "Specialized on elderly women",
"businessPurposes": [
"5065",
"5085",
"Financial services"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"liability": "PERSONAL",
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "string",
"share": 0.51
}
],
"shareholdersStructure": {
"complexOwnership": "string"
},
"staff": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "ACCOUNT_MANAGER"
}
],
"trademark": "IBM"
},
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"customerGroupId": 32112388,
"customerId": 4681354,
"customerRelationshipDetails": {
"allAccounts": [
{
"accountClosureDate": "string",
"accountEmailId": "string",
"accountId": "string",
"accountNumber": "string",
"accountOpeningDate": "string",
"accountStatus": "string",
"accountType": "string",
"attributes": [
"string"
],
"bankCountry": "string",
"bankIdentifier": "string",
"bankName": "string",
"contractualDetails": {
"contractEndDate": "2020-05-16",
"contractOneOffPayment": 100,
"contractStartDate": "2020-05-16",
"contractStatus": "ACTIVE",
"contractValueMonthly": 100,
"contractValueTotal": 10000,
"contractValueYearly": 1000
},
"countryOfSettlement": "NL",
"creditLimitDetails": {
"amount": 1005,
"currency": "EUR"
},
"currency": "string",
"expiry": "string",
"flags": [
"string"
],
"holder": "string",
"last4Digits": "string",
"location": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"overdraftLimit": 0,
"productCode": "string",
"productType": "string",
"scheme": "string",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
]
}
],
"businessUnit": "GAMBLING",
"exemptions": [
"string"
],
"staff": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "ACCOUNT_MANAGER"
}
]
},
"customerSince": "2014-01-15",
"customerStatus": "string",
"customerType": "CORPORATION",
"dba": [
{
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
}
],
"deviceDetails": {
"deviceId": "C02LM2CSFD59",
"deviceType": "iPhone",
"entryChannel": "Browser",
"operatingSystem": "Windows11"
},
"flags": [
"string"
],
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"referenceAccount": {
"accountClosureDate": "2021-01-02",
"accountEmailId": "harles.hollinten@mail.com",
"accountId": 435863453,
"accountNumber": "DE12500105170648489890",
"accountOpeningDate": "2021-01-01",
"accountStatus": "open",
"accountType": "checking account",
"attributes": [
"PND account"
],
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"bankName": "STADTSPARKASSE MUENCHEN",
"currency": "BTC",
"expiry": 202911,
"holder": "John Smith",
"last4Digits": 435863453,
"location": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"overdraftLimit": 500,
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
]
},
"registrationDetails": {
"internetServiceProvider": "Vodafone",
"ipAddress": "172.217.22.14",
"ipCountry": "PT"
},
"riskLevel": "low",
"role": "Primary",
"signedProducts": [
"checking-account",
"visa-debit-card",
"mortgage"
],
"taxId": "079 / 123 / 12347",
"taxIdType": "string"
},
"counterpartyData": {
"companyDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"businessDescription": "Specialized on elderly women",
"businessPurposes": [
"5065",
"5085",
"Financial services"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"liability": "PERSONAL",
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "string",
"share": 0.51
}
],
"shareholdersStructure": {
"complexOwnership": "string"
},
"staff": [
{
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"role": "ACCOUNT_MANAGER"
}
],
"trademark": "IBM"
},
"contactDetails": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"customerId": 4681354,
"dba": [
{
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
}
],
"personalDetails": {
"assessments": [
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
],
"countryOfBirth": "FR",
"countryOfResidence": "DE",
"dateOfBirth": "1977-01-08",
"gender": "f",
"identityDocuments": [
{
"expiryDate": "2025-01-15",
"id": "F8624KW3J6",
"issuingAuthority": "President of Warsaw",
"issuingCountry": "US",
"issuingState": "AZ",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
],
"nationality": "BE",
"occupation": "Teacher",
"personName": {
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate",
"nameAtBirth": "Carlton"
},
"placeOfBirth": "Paris",
"socialSecurityNumber": "078-05-112"
},
"referenceAccount": {
"accountClosureDate": "2021-01-02",
"accountEmailId": "harles.hollinten@mail.com",
"accountId": 435863453,
"accountNumber": "DE12500105170648489890",
"accountOpeningDate": "2021-01-01",
"accountStatus": "open",
"accountType": "checking account",
"attributes": [
"PND account"
],
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"bankName": "STADTSPARKASSE MUENCHEN",
"currency": "BTC",
"expiry": 202911,
"holder": "John Smith",
"last4Digits": 435863453,
"location": {
"addressValidSince": "2017-04",
"allAssignedCustomerIds": [
"I-234982-324-1232",
"I-342512-121-4123"
],
"contactId": "K3408534094",
"contactName": "Adam Smith",
"contactNameExtended": "c/o Mrs Camber",
"country": "DE",
"emailAddresses": [
"noreply@company.com",
"john.smith@shoutlook.com"
],
"phoneNumbers": [
"+4915178859632",
"+4915178858526"
],
"region": "BY",
"regionExtended": "Maricopa",
"street": "Leopoldstr. 12",
"streetExtended": "apt. RE-243",
"town": "Munich",
"unstructuredAddress": "Taunusanlage 12 60325, Frankfurt Am Main, DE",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
],
"zip": 81737
},
"overdraftLimit": 500,
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA",
"webLinks": [
{
"title": "google",
"url": "http://www.google.com"
}
]
},
"role": "Primary",
"taxId": "079 / 123 / 12347",
"taxIdType": "string",
"verificationDate": "1970-01-01"
},
"flags": [
"string"
],
"underwriterData": {
"name": "Wells P. Morgan",
"underwriterId": "K3408534094"
}
},
"network": "ETHEREUM"
}
CustomerResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| caseId | string | false | none | Case Id for the hawk:AI case manager. |
| customerId | string | false | none | Customer id where value is one of following: - customerId provided within GatewayTransaction request - generated UUID if customerId has not been provided |
| riskLevel | string | false | none | Determined risk level of customer |
| riskFactors | [RiskFactors] | false | none | List of risk factors detected, contains only risk factors which score value is above zero |
| screeningResults | [ScreeningResults] | false | none | List of types detected during customer screening |
RiskFactorsResponse
{
"factor": "Country of residence"
}
RiskFactorsResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| factor | string | false | none | Name of risk factor |
ScreeningResultsResponse
{
"type": "SPECIAL_INTEREST_PERSON"
}
ScreeningResultsResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | Detected customer screening type Examples: - POLITICALLY_EXPOSED_PERSON - SPECIAL_INTEREST_ENTITY - SPECIAL_INTEREST_PERSON - SANCTIONED_ENTITY - SANCTIONED_PERSON - RELATIVE_OR_CLOSE_ASSOCIATE - BLACKLIST_ENTITY - BLACKLIST_PERSON - ADVERSE_MEDIA |