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
transaction-checks-controller
Perform transaction checks on a new transaction
Code samples
POST /v1/transaction-checks
Body parameter
For example request body file please visit: Transaction Checks - New Transaction
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | GatewayTransaction | true | gatewayTransaction |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully started with transaction checks and already finished immediate decision | TransactionResponse |
| 201 | Created | Created | None |
| 202 | Accepted | Successfully started with transaction checks but immediate decision is not available yet | TransactionResponse |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
| 404 | Not Found | Not Found | None |
Reprocess transaction checks on a existing transaction
Code samples
PATCH /v1/transaction-checks
Body parameter
For example request body file please visit: Transaction Checks - Existing Transaction
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| caseId | query | string | false | caseId |
| body | body | GatewayTransaction | true | gatewayTransaction |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully started with transaction checks and already finished immediate decision | TransactionResponse |
| 202 | Accepted | Successfully started with transaction checks but immediate decision is not available yet | TransactionResponse |
| 204 | No Content | No Content | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden | None |
Schemas
For the most recent detailed schema description please visit:
Swagger Documentation
Account
{
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
Account
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). |
| expiry | string | false | none | Expiry month of the account details |
| 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) |
| scheme | 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) |
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) |
AccountHoldingPartyData
{
"accountReplaced": true,
"accountReplacedNotes": "Chargeback rate exceeded",
"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,
"expectedVolumeYearly": 1000000,
"expectedVolumeVolatility": "SEASONAL"
},
"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": {},
"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"
}
]
},
"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"
},
"customerGroupId": "32112388",
"customerId": "4681354",
"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": "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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
},
"riskLevel": "low",
"signedProducts": [
"checking-account",
"visa-debit-card",
"mortgage"
],
"taxId": "079 / 123 / 12347"
}
AccountHoldingPartyData
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountReplaced | boolean | false | none | True if the account has been replaced before (see AccountReplacedNotes for reasoning) |
| accountReplacedNotes | string | false | none | Reasoning for why the account has been replaced |
| characteristics | Characteristics | false | none | none |
| companyDetails | CompanyDetails | false | none | none |
| contactDetails | ContactDetails | false | none | none |
| customerGroupId | string | true | none | A hierarchy level for customers. Can be an internal grouping of customers or the name of a department the customer is assigned to |
| customerId | string | true | none | Customer number that identifies the customer uniquely in the system of the bank |
| customerSince | string(date) | false | none | The account holder is customer since the provided date |
| customerStatus | string | false | none | Customer status of the account holding party - KEY_ACCOUNT - NEW - MONITORING - ... (request additional values if required) |
| customerType | string | true | none | Type of customer. Example values: - ASSOCIATION - CORPORATION - GOVERNMENT_AGENCY - INDIVIDUAL - INTERNAL_ORGANIZATION - LIMITED_LIABILITY_COMPANY - PARTNERSHIP - TAX_EXEMPT_ORGANIZATION - UNKNOWN (provide only if unknown is exceptional) Other values are possible. Please reach out. |
| dba | [ContactDetails] | true | none | 'Doing-business-as contact details |
| personalDetails | PersonalDetails | false | none | none |
| referenceAccount | Account | false | none | none |
| riskLevel | string | true | none | Expected level of risk, describing the likeliness that the bank customer is involved in fraudulent activities |
| signedProducts | [string] | true | none | List the products the account holder signed |
| taxId | string | false | none | Tax id (VAT, Tax number, permant tax identification) that uniquely identifies the holder |
Assessment
{
"date": "2020-01-24",
"name": "FICO",
"notes": "Manually reviewed",
"referenceId": "56461a6315",
"score": 756,
"status": "DONE"
}
Assessment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date) | false | none | Date the reflects the state of the information provided (YYYY-MM-DD) |
| name | string | false | none | Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples: - EQUIFAX - FICO - IDOLOGY - INTERNAL - KYC - OFAC - SCHUFA - VERID - ... (please reach out to request other values) |
| notes | string | false | none | Free text for notes or comments regarding the assessment |
| referenceId | string | false | none | Reference to the original assessment |
| score | number(double) | false | none | Score that was given in the assessment. The range of the score depends on the assessment |
| status | string | false | none | Status of the assessment. _Examples: - IN_PROGRESS - DONE |
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. |
CompletableFuture/ResponseEntity/CustomerResponse
{
"cancelled": true,
"completedExceptionally": true,
"done": true,
"numberOfDependents": 0
}
CompletableFuture«ResponseEntity«CustomerResponse»»
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cancelled | boolean | false | none | none |
| completedExceptionally | boolean | false | none | none |
| done | boolean | false | none | none |
| numberOfDependents | integer(int32) | false | none | none |
CompletableFuture/ResponseEntity/TransactionResponse
{
"cancelled": true,
"completedExceptionally": true,
"done": true,
"numberOfDependents": 0
}
CompletableFuture«ResponseEntity«TransactionResponse»»
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cancelled | boolean | false | none | none |
| completedExceptionally | boolean | false | none | none |
| done | boolean | false | none | none |
| numberOfDependents | integer(int32) | false | none | none |
Configuration
{
"overwrites": {
"pepSanctionActive": "true"
},
"path": "Europe"
}
Configuration
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| overwrites | object | false | none | Overwrite values from config. Provide full path or named shortcut. |
| » additionalProperties | string | false | none | none |
| path | string | false | none | Path to subtenant relative to the level that is provided by the API-key. Subtenants typically represent sections of business that require specific rule sets. |
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.comi"
],
"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 |
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"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"companyDetails": {},
"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"
}
]
},
"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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
}
CounterpartyData
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyDetails | CompanyDetails | false | none | none |
| contactDetails | ContactDetails | false | none | none |
| personalDetails | PersonalDetails | false | none | none |
| referenceAccount | Account | false | none | none |
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 |
CustomerResponse
{
"caseId": "fcf14ed5-939b-4d24-a7d5-8166a2701c10",
"customerId": "481354",
"riskLevel": "12345",
}
TransactionResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| caseId | string | false | none | Case Id for the AML.AI case manager. |
| customerId | string | false | none | Customer number that identifies the customer uniquely in the system of the bank |
| riskLevel | string | false | none | Expected level of risk, describing the likeliness that the bank customer is involved in fraudulent activities |
Distribution
{
"labels": [
"MAGNETIC_STRIPE"
],
"share": 0.75
}
Distribution
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| labels | [string] | false | none | Specify the kind of distribution. |
| share | number(double) | false | none | Share of the defined label |
ExchangeRate
{
"factor": 0.6501,
"sourceCurrency": "CAD"
}
ExchangeRate
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| factor | number | false | none | Factor applied for the exchange from the given source currency to the configured base currency |
| sourceCurrency | string | false | none | Source currency of the exchange. TargetCurrency is the configured base currency |
GatewayCustomerChecks
{
"masterData": {
"accountHoldingPartyData": {
"accountReplaced": true,
"accountReplacedNotes": "Chargeback rate exceeded",
"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"
},
"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": {},
"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"
}
]
},
"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"
},
"customerGroupId": "32112388",
"customerId": "4681354",
"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": "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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
},
"riskLevel": "low",
"signedProducts": [
"checking-account",
"visa-debit-card",
"mortgage"
],
"taxId": "079 / 123 / 12347"
},
"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"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"companyDetails": {},
"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"
}
]
},
"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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
},
"underwriterData": {
"name": "Wells P. Morgan",
"underwriterId": "K3408534094"
}
}
}
GatewayCustomerChecks
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| masterData | MasterData | false | none | none |
GatewayTransaction
{
"accountHoldingParty": "FUNDS_ORIGINATOR",
"appendedCustomData": {
"additionalCustomerId": "1231"
},
"balanceBeforeTransaction": 8473.25,
"balanceCurrency": "EUR",
"callbackUrl": "https://callback.url/1234",
"cashbackAmount": 10,
"cashbackFeeAmount": 0.1,
"channel": "ECOMMERCE",
"configuration": {
"overwrites": {
"pepSanctionActive": "true"
},
"path": "Europe"
},
"fundsBeneficiary": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
},
"fundsOriginator": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
},
"initiatedAmount": 86.24,
"initiatedCurrency": "USD",
"initiatingParty": "FUNDS_ORIGINATOR",
"masterData": {
"accountHoldingPartyData": {
"accountReplaced": true,
"accountReplacedNotes": "Chargeback rate exceeded",
"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"
},
"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": {},
"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"
}
]
},
"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"
},
"customerGroupId": "32112388",
"customerId": "4681354",
"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": "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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
},
"riskLevel": "low",
"signedProducts": [
"checking-account",
"visa-debit-card",
"mortgage"
],
"taxId": "079 / 123 / 12347"
},
"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"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"companyDetails": {},
"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/aml-ai"
],
"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"
},
"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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
},
"underwriterData": {
"name": "Wells P. Morgan",
"underwriterId": "K3408534094"
}
},
"paymentMeans": "CASH",
"paymentType": "REFUND",
"purposeCode": "SSBE",
"settledAmount": 99.98,
"settledCurrency": "EUR",
"tenantProcessingTimestamp": "2019-10-16T14:38:47.812",
"tenantTransactionId": "1234",
"tipAmount": 5,
"transactionProcessingDetails": {
"appliedExchangeRates": [
{
"factor": 0.6501,
"sourceCurrency": "CAD"
}
],
"avsCheckPass": "NOT_VERIFIED",
"avsCheckResultCode": "L",
"catLevel": "IN_FLIGHT",
"cvvCheckPass": "TRUE",
"cvvCheckResultCode": "M",
"entryMode": "ICC_CONTMANACTLESS",
"networkResponseCode": "AC04",
"pinCheckPass": "TRUE",
"securityLevel": "3D_SECURE",
"terminalId": "23107748"
},
"transactionResult": "FRAUD_SUSPICION",
"transactionResultMessage": "string",
"usage": "Testing"
}
GatewayTransaction
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountHoldingParty | string | true | none | The party that is holding an account with the tenant. |
| appendedCustomData | object | false | none | Any additional tenant data that is relevant for processing as json string. |
| » additionalProperties | string | false | none | none |
| balanceBeforeTransaction | number | false | none | Balance of account before the transaction took place. Two or three decimal places accepted depending on currency. |
| balanceCurrency | string | false | none | Currency of tenant account in ISO alpha-3 code format. |
| callbackUrl | string | true | none | Url that is called for any changes to the transaction status e.g.Operator marks the transactions as unsuspicious and systems posts to callback url. |
| cashbackAmount | number | false | none | Amount that is cash back as in Credit Card transactions |
| cashbackFeeAmount | number | false | none | The fee that has to be paid for the cashback |
| channel | string | false | none | Channel used to facilitate the payment. Examples: - ATM - BACKOFFICE, - BANKING - BRANCH - ECOMMERCE - INITIATION_SERVICE - INTERNET - MCOMMERCE - MOBILE_BANKING - MOTO - NOT_AVAILABLE (only if it is typically available but not available on single occasions.If the channel is never available in your usecase, don't send anything) - ONLINE_BANKING - OTHER (reach out to request additional values!) - POS |
| configuration | Configuration | false | none | none |
| fundsBeneficiary | Account | false | none | none |
| fundsOriginator | Account | false | none | none |
| initiatedAmount | number | false | none | This is the amount the transaction was initiated in. If there is currency exchange, settled and initiated amounts differ. Two or three decimal places accepted depending on currency. |
| initiatedCurrency | string | false | none | This is the currency the transaction was initiated in ISO alpha-3 code format. If there is currency exchange, settled and initiated currencies differ. |
| initiatingParty | string | true | none | Which of the two parties involved initiated the transaction. |
| masterData | MasterData | false | none | none |
| paymentMeans | string | false | none | Means of the payment. Examples: - BILL - CHECK - FEES - PAYMENT - PREARRANGED - PURCHASE - QUASI_CASH - ... (please request if other values are required) |
| paymentType | string | true | none | Type of the transaction Defaults to CREDIT or DEBIT depending on originator and beneficiary. Examples: - ACCOUNT_VERIFICATION - AUTHORIZATION - AUTHORIZATION_CAPTURE - AVS_ONLY - BALANCE_INQUIRY - CAPTURE - CAPTURE_HOLD - CAPTURE_HOLD_RELEASE - CHARGEBACK - DEATH_NOTIFICATION - FEE - REFUND - REFUND_WITHOUT_AUTHORIZATION - REVERSAL |
| purposeCode | string | false | none | For SEPA transaction use SEPA purpose codes, for non-SEPA use corresponding codes as applicable in the region/market. |
| settledAmount | number | true | none | This is the amount that is shown on the bank statement of the customer. Two or three decimal places accepted depending on currency. |
| settledCurrency | string | true | none | Currency of the customer in ISO alpha-3 code format. |
| tenantProcessingTimestamp | string(date-time) | true | none | Timestamp the transaction is processed at the tenant in UTC time zone. |
| tenantTransactionId | string | true | none | ID of the transaction at the tenant. |
| tipAmount | number | true | none | Tip amount - as used typically in card payments. Same currency as settled currency |
| transactionProcessingDetails | TransactionProcessingDetails | false | none | none |
| transactionResult | string | true | none | FRAUD_SUSPICION, CARD_STOLEN, CARD_LOST, INSUFFICIENT_FUNDS, SUSPICIOUS_MERCHANT_SETUP, INVALID_CVV and more |
| transactionResultMessage | string | false | none | Textual description for the transaction result as provided by scheme operator |
| usage | string | true | none | Free text the initiating party sends with the transaction. |
Enumerated Values
| Property | Value |
|---|---|
| accountHoldingParty | FUNDS_ORIGINATOR |
| accountHoldingParty | FUNDS_BENEFICIARY |
| initiatingParty | FUNDS_ORIGINATOR |
| initiatingParty | FUNDS_BENEFICIARY |
IdentityDocument
{
"id": "F8624KW3J6",
"kind": "PASSPORT",
"link": "https://intranet.bank.com/customers/98234792/passport"
}
IdentityDocument
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Id/number identifiying as printed on the document. E.g. passport number |
| kind | string | false | none | Kind of identity document provided. Examples: - DRIVING_LICENSE - NATIONAL_IDENTITY_CARD - PASSPORT - SOCIAL_SECURITY - ... (reach out if further values are required) |
| link | string | false | none | Link to scan of identity document |
MasterData
{
"accountHoldingPartyData": {
"accountReplaced": true,
"accountReplacedNotes": "Chargeback rate exceeded",
"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,
"expectedVolumeYearly": 1000000,
"expectedVolumeVolatility": "SEASONAL"
},
"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": {},
"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"
}
]
},
"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"
},
"customerGroupId": "32112388",
"customerId": "4681354",
"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": "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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
},
"riskLevel": "low",
"signedProducts": [
"checking-account",
"visa-debit-card",
"mortgage"
],
"taxId": "079 / 123 / 12347"
},
"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"
],
"companyId": "C0785283592",
"companyName": "The BORing company",
"countryOfRegistration": "PT",
"division": "Mortgage",
"inBusinessSince": "2019-03",
"legalForm": "2HBR",
"organizationType": "NON_PROFIT",
"shareholders": [
{
"companyDetails": {},
"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"
}
]
},
"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"
},
"referenceAccount": {
"accountEmailId": "harles.hollinten@mail.com",
"accountId": "435863453",
"accountNumber": "DE12500105170648489890",
"bankCountry": "FR",
"bankIdentifier": "SSKMDEMM",
"expiry": "202911",
"holder": "John Smith",
"last4Digits": "3453",
"productCode": "BPD",
"productType": "CREDIT_CARD",
"scheme": "SEPA"
}
},
"underwriterData": {
"name": "Wells P. Morgan",
"underwriterId": "K3408534094"
}
}
MasterData
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountHoldingPartyData | AccountHoldingPartyData | false | none | none |
| counterpartyData | CounterpartyData | false | none | none |
| underwriterData | UnderwriterData | false | none | none |
PersonName
{
"firstName": "Barbara-Maria",
"lastName": "Kensigton",
"middleNames": "Helen Kate"
}
PersonName
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string | true | none | First name / given name |
| lastName | string | false | none | Last name / family name |
| middleNames | string | false | none | Middle name(s) separated with space |
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 |
RelatedTransaction
{
"tenantTransactionId": "1234"
}
RelatedTransaction
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| RelatedTransaction | string | true | none | ID of the transaction at the tenant. |
Shareholder
{
"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": {},
"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"
}
]
},
"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
}
Shareholder
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| companyDetails | CompanyDetails | false | none | none |
| contactDetails | ContactDetails | false | none | none |
| liability | string | false | none | Liability taken. Examples: - LIMITED - PERSONAL - ... (reach out of additional values are required) |
| personalDetails | PersonalDetails | false | none | none |
| role | string | false | none | Role/Title/function of the shareholder within the company Examples: - FOUNDER - COFOUNDER - OWNER - MAYORITY_SHAREHOLDER - BOARD_MEMBER - ... (reach of for further values) |
| share | number | false | none | Kept share up to max 1 (=100%) |
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) |
TransactionProcessingDetails
{
"appliedExchangeRates": [
{
"factor": 0.6501,
"sourceCurrency": "CAD"
}
],
"avsCheckPass": "NOT_VERIFIED",
"avsCheckResultCode": "L",
"catLevel": "IN_FLIGHT",
"cvvCheckPass": "TRUE",
"cvvCheckResultCode": "M",
"entryMode": "ICC_CONTMANACTLESS",
"location": {
"contactId": "K3408534094",
"contactName": "Branch name",
"country": "DE",
"region": "BY",
"regionExtended": "Bayern",
"street": "Leopoldstr. 12",
"town": "München",
"zip": "81737"
},
"networkResponseCode": "AC04",
"pinCheckPass": "TRUE",
"securityLevel": "3D_SECURE",
"terminalId": "23107748"
}
TransactionProcessingDetails
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| appliedExchangeRates | [ExchangeRate] | false | none | The exchange rate(s) that were actually applied when processing the transaction. Provide the exchange rates for all given currencies to the configured, tenant-wide base currency. |
| avsCheckPass | string | false | none | Mapped AVS result codes. Preferably provide scheme operator's raw codes (see avsCheckResultCode) Examples: - TRUE - FALSE - NOT_VERIFIED - PARTIAL |
| avsCheckResultCode | string | false | none | Raw AVS result codes as provided by the scheme operator (see here). Provide mapped values if raw values are not available (see _avsCheckPass). Examples: - L (Visa/Master: Street address matches ,ZIP does not) - S (AVS not supported) - ... |
| catLevel | string | false | none | Level of Cardholder Activated Terminal (CAT) used. See here for reference Examples: - 'NOT_A_CAT' (Level 0) - 'AUTOMATED_DISPENSING' (CAT1) - 'SELF_SERICE' (CAT2) - 'LIMITED_AMOUNT' (CAT3) - 'IN_FLIGHT' (CAT4) - 'ECOMMERCE' (CAT6, includes DSRP and Masterpass) - 'TRANSPONDER' (CAT7) - 'MPOS' (CAT9, attended and unattended) |
| cvvCheckPass | string | false | none | Mapped AVS result codes. Preverably provide scheme operator's raw codes (see cvvCheckResultCode) Examples: - TRUE - FALSE - NOT_VERIFIED |
| cvvCheckResultCode | string | false | none | Raw CVV result codes as provided by the scheme operator (see e.g. here for Visa). Provide mapped values if raw values are not available (see _avsCheckPass)If no raw codes are available provde a mapping in avsCheckPass. Example values: - M (for Master/Visa match) - U (for Master/Visa/Discover not certified) - Y (for Amex match) - ... |
| entryMode | string | false | none | Entry Mode as at point of service. Possible values are dependent on used payment method. E.g. as defined in ISO 8585: - MCOMMERCE, - SERVER, - CARD_ON_FILE, - BAR_CODE, - OCR, - MAGNETIC_STRIPE, - ECOMMERCE, - ICC, - MAGNETIC_STRIPE_CONTACTLESS, - ICC_CONTACTLESS, - TOKEN_3RD_PARTY, - MICR (as in ACH), - MANUAL, - MANUAL_AS_FALLBACK, - MAGNETIC_STRIPE_AS_FALLBACK, - PIN, - PINLESS |
| networkResponseCode | string | false | none | Response code as provided by the scheme operator. Many schemes work with ISO 8583 response codes. Other schemes provide specific codes (e.g. SEPA reason codes) Examples: - 5 ('Do not honor' for Mastercard, 'Deny' for Amex) - AC04 ('Account closed' for SEPA) - ... |
| pinCheckPass | string | false | none | Mapped PIN check result codes. Examples:- TRUE - FALSE - NOT_VERIFIED |
| securityLevel | string | false | none | The Security Level Indicator indicates the security level of the acquiring environment Examples: - ENCRYPTED - NOT_RELEVANT - RECURRING - REVOLVING - ENCRYPTED - NO_SECURITY - 3D_SECURE - 3D_SECURE_SUCCESS - 3D_SECURE_MERCHANT_ENABLED_NOT_AUTHENTICATED - 3D_SECURE_PREVIOUS_SUCCESS - EWALLET_AUTH_NONE - EWALLET_AUTH_NOT_USED - EWALLET_AUTH_SUCCESS (E-Wallets such as V.me, Masterpass or anyother provider) - EWALLET_AUTH_STATIC - EWALLET_AUTH_SUCESS_ISSUING_BANK_DECISION - EWALLET_AUTH_NONE_MERCHANT_DECISION_ENABLED |
| terminalId | string | false | none | TerminalId of the used terminal |
TransactionResponse
{
"caseId": "fcf14ed5-939b-4d24-a7d5-8166a2701c10",
"proceed": true,
"tenantTransactionId": "1234",
"took": 0
}
TransactionResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| caseId | string | false | none | Case Id for the AML.AI case manager. |
| proceed | boolean | false | none | Should the transaction proceed (true) or be blocked (false). |
| tenantTransactionId | string | false | none | ID of the transaction at the tenant. |
| took | integer(int64) | false | none | none |
UnderwriterData
{
"name": "Wells P. Morgan",
"underwriterId": "K3408534094"
}
UnderwriterData
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | none | Name of the underwriter |
| underwriterId | string | false | none | Id that helps referencing the information back to the system from which the data originates |
Important
The previous version of the Transaction Checks API, AML Checks, has been deprecated. This change has no impact on existing integrations which will continue to be supported.