Transactions and customers supported fields for Go!KYT
Field name | Type | Required | Description |
---|---|---|---|
external_id | string | Yes | Your unique identifier of the transaction |
date | string | Yes | Date of the transaction in ISO format (2023-07-05T08:18:05.661Z ) |
from | Participant | Yes | Sender of the transaction |
to | Participant | Yes | Receiver of the transaction |
amount | string | Yes | Amount of the transaction converted to string, ex. "0.01233110" |
currency | string | Yes | Currency of the transaction, ex. "BTC" or "EUR" |
crypto | Crypto | No | (Crypto only) Specify additional information about a crypto transaction |
comment | string | No | Comment for this transaction |
fields | object | No | Custom fields for this transaction, key-value object, see ‘custom fields’ section |
review_groups | string | No | Review groups for this transaction separated by ; , ex. A;B , see [/docs/common/review-groups](review groups) |
Crypto
Field name | Type | Required | Description |
---|---|---|---|
blockchain | string | No | (Crypto only) Specify network where token was exchanged, ex. "AVAX" or "ETH" |
txhash | string | No | (Crypto only) Fingerprints of the transaction, ex. "0x1234" |
Field name | Type | Required | Description |
---|---|---|---|
external_id | string | Yes | External identifier of the participant, it can match or not a customer already existing in Algoreg |
full_name | string | Yes | Full name of the participant, ignored if external_id matches a known customer |
account_type | string | Yes | ”F” or “N”, Firm (F), Individual (N), ignored if external_id matches a known customer |
domicile_code | string | No | Country in ISO3 format, ex. FRA , ignored if external_id matches a known customer |
device | Device | No | Device used for the transaction, IP, browser, location etc |
payment_institution | PaymentInstitution | No | Payment institution (bank, VASP, etc) of the participant, see below |
payment_method | PaymentMethod | No | Payment method of the participant, see below |
Device
Field name | Type | Required | Description |
---|---|---|---|
fingerprint | string | No | Device fingerprint |
user_agent | string | No | User agent of the device, ex. Mozilla/5.0 ... |
language | string | No | Accepted language, ex. en |
geolocation | string | No | Geolocation in this format: lat;lon;accuracy_km |
country | string | No | Country in ISO3 format, ex. FRA |
ip | string | No | IP address of the device, ex. 1.2.3.4 |
session_id | string | No | Session identifier, ex. 1234 |
session_duration | number | No | Session lifetime in ms, ex. 127 means a very rapid session |
3ds | boolean | No | 3DS authentication enabled or not, ex. true |
2fa | boolean | No | 2FA authentication enabled or not, ex. true |
PaymentInstitution
Field name | Type | Required | Description |
---|---|---|---|
external_id | string | No | If defined, we will match the institution to a customer defined in Algoreg |
code | string | No | Code the payment institution, BIC for instance |
name | string | No | Name of the payment institution, ex. BNP Paribas |
country | string | No | Country in ISO3 format, ex. FRA |
PaymentMethod
Field name | Type | Required | Description |
---|---|---|---|
type | string | No | Type of the payment method, ex. card , crypto , bank , exchange |
code | string | No | Code of the payment method, ex. IBAN for bank , hash of the card for card , wallet address for crypto , or crypto pair for exchange |
country | string | No | Issuing country in ISO3 format, ex. FRA |