Entity

Entity schema.

accountManager object

Entity Account Manager

anyOf

• EntityAccountManager
• null

emailstringrequired

Account Manager Email

Example: example@treasuryspring.com

namestringrequired

Account Manager Name

Example: example

phonestring | nullnullable

Account phone number

addressstring | nullnullable

Entity Address

bankAccounts object[]required

List of bank accounts for the entity

Array [

currencystringrequired

Bank Account currency

Example: GBP

lastDigitsstringrequired

last 4 digits of the account number

Example: 1234

uidstringrequired

Bank Account uid

Example: 3e3020d02361470fa5839b2a456102b7

]

codestringrequired

Entity Code

Example: TEST0001

countryCodestring | nullnullable

Country code

Example: GB

currencystringrequired

Default Currency

Example: GBP

namestringrequired

Entity Name

Example: TreasurySpring Limited

onboardingbooleanrequired

True if entity is in the process of onboarding

statusstringrequired

Entity Status

Examples:

Example 1

Example: ACTIVE

Example 2

Example: PENDING

typestringrequired

Description of the Entity Type

Entity

{
  "accountManager": {
    "email": "example@treasuryspring.com",
    "name": "example",
    "phone": "string"
  },
  "address": "string",
  "bankAccounts": [
    {
      "currency": "GBP",
      "lastDigits": "1234",
      "uid": "3e3020d02361470fa5839b2a456102b7"
    }
  ],
  "code": "TEST0001",
  "countryCode": "GB",
  "currency": "GBP",
  "name": "TreasurySpring Limited",
  "onboarding": true,
  "status": "ACTIVE",
  "type": "string"
}