v1

latestOpenAPI 3.1.02026-08-043160244.3 KB

Entities

Get a single entity by entity code

Retrieves data for a single Entity if the user has permission to view it.

get/entity/{code}

Path parameters

codestring required

Entity code

Response

Entity information

addressstring nullable

Entity Address

codestring required

Entity Code

countryCodestring nullable

Country code

currencystring required

Default Currency

namestring required

Entity Name

onboardingboolean required

True if entity is in the process of onboarding

statusstring required

Entity Status

typestring required

Description of the Entity Type

Example response

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