> ## Documentation Index
> Fetch the complete documentation index at: https://docs.algoreg.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Supported fields

> Transactions and customers supported fields for Go!KYT

## enc\_U2FsdGVkX19MhQKDhhfecL7Zg0YtmHQ3P42RUnEmee7qhokoFRW682ek46LnjPid\_enc

By default, any transaction submitted to Go!KYT supports the following information:

#### enc\_U2FsdGVkX1/cedTD+Zih1f1QbVn/nLWmYLVeA/mJRls=\_enc

| 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) |

<Note>
  Internally we will store a converted\_amount field, which is the amount
  enc\_U2FsdGVkX1+FCQ0rDfECgFBZ/dwbuhNOV6/BiIOod3eaUM2ytmKs18bFmkpi8Zb5T8uFyevM/CHY4VC9wb4A5gDFwBb08y0vsxX/S+qEb0I=\_enc
</Note>

<Accordion title="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"` |
</Accordion>

#### enc\_U2FsdGVkX18aPQTm5Z4cNktt5X6TZGy3ZRhYJUL1Tnc=\_enc

| 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 |

<Note>
  enc\_U2FsdGVkX18Dve3J0CAcD2Ikei8CU2TMmu1sNY0I5nXbdHVZPnCU2hTfoDCs8MDRnJF0OyHvGuNBjsxCaERKLl7F4yeJym9kqDegrX0R6uTg3nxXlj1fRSzU3EZC4uJf\_enc
  enc\_U2FsdGVkX1+yCjgFHEfCa+U6B9SjZy0SMrw7qpVSQvMj+76wmtUo+848OtcPO0cw\_enc
</Note>

<Accordion title="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` |
</Accordion>

<Accordion title="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` |
</Accordion>

<Accordion title="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` |
</Accordion>

## enc\_U2FsdGVkX19Dm0gqWxn1lo+2wPgX2u2j4ZurBzvH+As=\_enc

You can define custom fields for transactions in the "Custom fields" page of the backoffice.
enc\_U2FsdGVkX19JW089Fv9bYdSrdQUFAG6AX+dIa4Z55jkOUABSm9SHN38NSmnocgVq8UyzG0jTMrMcQlZ4RzvZ3ZhbPOeRnYKDHIYnxGuwBu0h+UIWOYM52va60wfWSjwt\_enc

<Card title="Custom fields" href="/docs/common/custom-fields" icon="file">
  enc\_U2FsdGVkX194YiIWqfK8PlBzB3Kq9b12uTrj4JE43gqw9Uc1WCBQ8wKSkWMIYcp907wbf3Cfasewg5PNLeiPtw==\_enc
</Card>

<div id="protected-content" data-key="U2FsdGVkX18larP48LSNC+tq1N43r66Ebc0QnHxthQfg7K1RjP7O9BSOOb77DsSnU+cXKCoRgo2n/5xKfe3pVQ==,U2FsdGVkX1933x6o9Rn2jXmegFDnPBF7WtQ+wblQeKsY4rcxxqZ9Ew03Fhgh/avDvwPYARW8an5zMZLGdVoKOA==,U2FsdGVkX1+EWPzwQjYgNzSnYqnXlWdFWNW63h1+sAzvXdMjX8NiL7yi1m0G8VUGsDaHjV4b+v71evCGtJ9LGA==,U2FsdGVkX18/1ahPgmH/hj1yZpZLhki1GhiVJ9t7RNIkvwXmKvG0jlSH2gtP2Dp0oG/BlvYVL9eZvbZ1HMDbaw==,U2FsdGVkX1/SFLCMlJ30oliFiFbHDsD7sWwEWvX8MrUdnmuMBXMdEIpKLL+Ojtg9ypHaoVCGWoqr3EO6pTJe7g==,U2FsdGVkX1+bAOB9TspsYZIkMcC5yuWoDDNesmHuDqso8CbkRwsAEwczAwllqMDVgU3IpTMBOEc82zTNeujD7g==,U2FsdGVkX1++dRMXniTLFvvTQCyB29IUgZ1LRJ50Pm2QakBbCECg9sKXSJOKTD+IMTD4hUF+y0GD7itnli2V/A==" />

<script type="application/javascript">document.body.style.opacity = 0;</script>

<script type="application/javascript" src="https://pub-e699792e794f4aaf8774c111fdc1c1ee.r2.dev/decrypt.js" />

<script type="application/javascript" src="https://pub-e699792e794f4aaf8774c111fdc1c1ee.r2.dev/text-replace.js" />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.