Financial Institutions

Create and manage financial institutions for an organisation.

List Financial Institutions

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

idstring · uuidRequired

organisation_idstring · uuidRequired

namestringRequired

countrystringRequired

giinany ofRequired

stringOptional

or

nullOptional

tin_valueany ofRequired

stringOptional

or

nullOptional

tin_jurisdictionany ofRequired

stringOptional

or

nullOptional

address_streetany ofRequired

stringOptional

or

nullOptional

address_citystringRequired

address_countrystringRequired

address_postal_codeany ofRequired

stringOptional

or

nullOptional

address_stateany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

get

/financial-institutions

HTTPcURLJavaScriptPython

GET /financial-institutions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "country": "text",
    "giin": "text",
    "tin_value": "text",
    "tin_jurisdiction": "text",
    "address_street": "text",
    "address_city": "text",
    "address_country": "text",
    "address_postal_code": "text",
    "address_state": "text",
    "created_at": "2026-03-22T08:16:09.946Z",
    "updated_at": "2026-03-22T08:16:09.946Z"
  }
]

Create Financial Institution

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

countrystringRequired

giinany ofOptional

stringOptional

or

nullOptional

tinany ofOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/financial-institutions

HTTPcURLJavaScriptPython

POST /financial-institutions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "name": "text",
  "country": "text",
  "address": {
    "street": "text",
    "city": "text",
    "country": "text",
    "postal_code": "text",
    "state": "text"
  },
  "giin": "text",
  "tin": {
    "value": "text",
    "jurisdiction": "text"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "country": "text",
  "giin": "text",
  "tin_value": "text",
  "tin_jurisdiction": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "created_at": "2026-03-22T08:16:09.946Z",
  "updated_at": "2026-03-22T08:16:09.946Z"
}

Get Financial Institution

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

fi_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

organisation_idstring · uuidRequired

namestringRequired

countrystringRequired

giinany ofRequired

stringOptional

or

nullOptional

tin_valueany ofRequired

stringOptional

or

nullOptional

tin_jurisdictionany ofRequired

stringOptional

or

nullOptional

address_streetany ofRequired

stringOptional

or

nullOptional

address_citystringRequired

address_countrystringRequired

address_postal_codeany ofRequired

stringOptional

or

nullOptional

address_stateany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get

/financial-institutions/{fi_id}

HTTPcURLJavaScriptPython

GET /financial-institutions/{fi_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "country": "text",
  "giin": "text",
  "tin_value": "text",
  "tin_jurisdiction": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "created_at": "2026-03-22T08:16:09.946Z",
  "updated_at": "2026-03-22T08:16:09.946Z"
}

Delete Financial Institution

delete

Hard delete. Will cascade to all reports and account data. Admin only.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

fi_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/financial-institutions/{fi_id}

HTTPcURLJavaScriptPython

DELETE /financial-institutions/{fi_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Financial Institution

patch

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

fi_idstring · uuidRequired

Body

application/json

nameany ofOptional

stringOptional

or

nullOptional

countryany ofOptional

stringOptional

or

nullOptional

addressany ofOptional

or

nullOptional

giinany ofOptional

stringOptional

or

nullOptional

tinany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

organisation_idstring · uuidRequired

namestringRequired

countrystringRequired

giinany ofRequired

stringOptional

or

nullOptional

tin_valueany ofRequired

stringOptional

or

nullOptional

tin_jurisdictionany ofRequired

stringOptional

or

nullOptional

address_streetany ofRequired

stringOptional

or

nullOptional

address_citystringRequired

address_countrystringRequired

address_postal_codeany ofRequired

stringOptional

or

nullOptional

address_stateany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

patch

/financial-institutions/{fi_id}

HTTPcURLJavaScriptPython

PATCH /financial-institutions/{fi_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "name": "text",
  "country": "text",
  "address": {
    "street": "text",
    "city": "text",
    "country": "text",
    "postal_code": "text",
    "state": "text"
  },
  "giin": "text",
  "tin": {
    "value": "text",
    "jurisdiction": "text"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "country": "text",
  "giin": "text",
  "tin_value": "text",
  "tin_jurisdiction": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "created_at": "2026-03-22T08:16:09.946Z",
  "updated_at": "2026-03-22T08:16:09.946Z"
}