List enabled providers for a branch

curl --request GET \
  --url https://api.example.com/api/v2/branches/{id}/providers

{
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idCheck": [],
  "sourceOfFunds": []
}

Organisations

List enabled providers for a branch

Returns the providers that are enabled in onboarding settings for the specified branch. Branch-level overrides are honoured; when a branch does not customise its onboarding configuration the organisation-level configuration is returned.

Use this before calling POST /api/v2/cases to confirm which checkProvider and sofProvider values are valid for the branch the case will be created against. Provider identifiers in the response use the same wire-format strings that POST /api/v2/cases accepts.

GET

api

branches

{id}

providers

List enabled providers for a branch

curl --request GET \
  --url https://api.example.com/api/v2/branches/{id}/providers

{
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idCheck": [],
  "sourceOfFunds": []
}

Path Parameters

string<uuid>

required

Branch ID

Response

Enabled providers grouped by service

branchId

string<uuid>

Branch the result is scoped to

idCheck

enum<string>[]

Valid values for clients[].checkProvider when creating a case

Available options:

yoti,

thirdfort,

title-guardian

sourceOfFunds

enum<string>[]

Valid values for clients[].sofProvider when creating a case. Only applicable when verificationOfFunds is true.

Available options:

upload,

thirdfort,

armalytix

List fee earners for a branch List branches