openapi: 3.0.0
info:
title: The Griffin API
description: >-
## Introduction
The Griffin API is based on
[REST](https://en.wikipedia.org/wiki/Representational_state_transfer).
It has resource-oriented URLs, accepts
[JSON](https://www.json.org/json-en.html)-encoded request bodies, returns
[JSON](https://www.json.org/json-en.html)-encoded responses, and uses
standard HTTP response verbs and response codes.
Our API deviates from strict RESTful principles if it makes sense to do so,
such as when we enforce tighter access controls around certain operations.
For example, when closing a bank account: rather than send a PATCH request
to the [bank account](http://docs.griffin.com) resource to update it's
status to `"closed"`, we provide a dedicated account closure resource.
Anyone can [create an account](https://app.griffin.com/register) with
Griffin and try out out API in [sandbox mode](http://docs.griffin.com).
New to Griffin? Check out our [getting started
guide](http://docs.griffin.com).
## Navigation
Our API is designed to be navigated programmatically. When you request any
resource, you will find the URLs for related resources in the response body.
The API is structured as a tree with your
[organization](http://docs.griffin.com) at the top. Everything that you own
will be a sub-resource of your organization.
To bootstrap the navigation process, request the
[index](http://docs.griffin.com) endpoint: the response will contain your
`organization-url`.
For a walkthrough, see our [getting started guide](http://docs.griffin.com).
## Pagination
Our list APIs support pagination (e.g. [list bank
accounts](http://docs.griffin.com) and [list
payments](http://docs.griffin.com)).
By default, a list API returns up to 25 results. If there are more results
available, the response payload will include links to the previous/next
pages.
### Change page size
You can request a different number of results (between 1 and 200, inclusive)
by using the `page[size]` query parameter:
```
GET /v0/organizations/:id/bank/accounts?page[size]=100
```
### Navigating between pages
List responses will include a `links` object with `prev` and `next`
attributes, as shown below.
Perform a GET request to the value of the attribute to fetch the
previous/next page of results.
```
{
"accounts": [
// ...
],
"links": {
"prev": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[before]=djE6WxSPxfYUTnCU9XtWzj9gGA",
"next": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[after]=djE6aw79PXZySUOL16LD8HRJ3A"
}
}
```
If there is no previous or next page available, the value of the attribute
will be null.
Any other query parameters included in the initial request will also be
included in the response payload's links.
If you want to change parameters (see [filtering and
sorting](http://docs.griffin.com)), request the first page and follow the
links from there.
## Filtering and sorting
### Sort results
By default, resources will be listed in descending order, usually based on
the `created-at` attribute.
You can change the sorting behaviour of a list of results by using the
`sort` query parameter.
For example, to list bank accounts in ascending order (oldest first):
```
GET /v0/organizations/:id/bank/accounts?sort=created-at
```
To _explicitly_ sort in descending order (newest first), prefix the sort
attribute with `-`:
```
GET /v0/organizations/:id/bank/accounts?sort=-created-at
```
### Filter results
Some list APIs allow you to filter the results.
Filters are expressed as nested data structures encoded into query
parameters.
For example, you can list bank accounts that are in either the `opening` or
`open` state with:
```
GET
/v0/organizations/:id/bank/accounts?filter[account-status][in][]=opening&filter[account-status][in][]=open
```
Similarly, you can list legal persons with a specific `application-status`:
```
GET
/v0/organizations/:id/legal-persons?filter[application-status][eq]=accepted
```
### Include resources
Some list APIs allow you to include associated resources in the response,
reducing the number of requests needed to fetch related data.
For instance, when listing bank accounts, you can include each bank
account's beneficiary legal person by using the `include` query parameter:
```
GET /v0/organizations/:id/bank/accounts?include=beneficiary
```
The response returns the usual list of bank accounts, but it will also have
an `included` object with a `legal-persons` attribute:
```
{
"accounts": [
// ...
],
"links": {
// ...
}
"included": {
"legal-persons": [
// ...
]
}
}
```
Check the documentation for each list API to see all options for sorting and
filtering
## Versioning
The Griffin API is versioned via a prefix in the URL.
The current version is v0.
An example endpoint is: https://api.griffin.com/v0/index.
We will not break your integration with a particular version for as long as
we support that version.
If we release a new version, you will have 12 months to upgrade to it.
version: ''
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- url: https://api.griffin.com
tags:
- description: >-
A payment captures the intent to move funds from a bank account to another
bank account. Outbound payments can be made from your [bank
account](http://docs.griffin.com) to a [payee](http://docs.griffin.com).
Griffin accepts inbound payments to your bank accounts on your behalf.
If it's your first time using our payments API, check out our guide for [making a payment](http://docs.griffin.com)
name: Payments
- name: Webhooks
- description: >
Bank accounts are used for managing funds. You can open different types of
bank account using the `"bank-product-type"` field. Some account types are
for managing your own funds and some are for managing your customers'
funds. For information, check out our guides for opening bank accounts:
- [open an operational account](http://docs.griffin.com).
- [open a safeguarding account](http://docs.griffin.com).
- [open a client money account](http://docs.griffin.com).
name: Bank accounts
- description: >-
The `api-key-secret` field is only shown once when you create an API key.
We cannot recover the value, so you should store it securely.
Pass an `Authorization` header with `GriffinAPIKey api-key-secret` to
authenticate.
Each API key is only valid for one
[organization](http://docs.griffin.com).
If you are a [member](http://docs.griffin.com) of multiple organizations,
you will need to create a new API key for each one.
There is currently no limit on the number of API keys you can create.
name: API keys
- description: >-
In the Griffin API, your organization and your customers are all
represented by [legal persons](http://docs.griffin.com). When you sign up
with Griffin, your organization will be automatically assigned a unique
legal person ID. When onboarding your customers, you will create legal
persons to represent them.
Every legal person has a `legal-person-type` with the value: `individual`
or `corporation`.
An `individual` represents an individual human.
A `corporation` represents any non-human entity (not just companies). A
corporation should have at least one [director](http://docs.griffin.com)
or [person with significant control](http://docs.griffin.com) attached to
it, who must also be represented as a distinct `individual` legal person.
name: Legal persons
- description: >-
A payee is the person or business to whom you are paying money. When you
create a payee, you need to provide their name (`"account-holder"`), and
their bank account number (`"account-number"`) and sort code
(`"bank-id"`).
name: Payees
- description: >-
Memberships represents the relationship between a
[user](http://docs.griffin.com) and an
[organization](http://docs.griffin.com).
A membership must have at least one [role](http://docs.griffin.com) assigned to it.
name: Memberships
- description: >-
A role represents a pre-defined set of capabilities that can be assigned
to a [user](http://docs.griffin.com) via their
[membership](http://docs.griffin.com) in an
[organization](http://docs.griffin.com). By default, the first user in an
organization gets assigned an administration role. Subsequent users get
assigned the most limited set of capabilities.
name: Roles
- name: Verifications
- description: >-
A [claim](http://docs.griffin.com) is an unverified data point or series
of data points attached to a [legal person](http://docs.griffin.com).
Claims are verified by running a [verification](http://docs.griffin.com)
against the legal person.
name: Claims
- description: >-
A [workflow](http://docs.griffin.com) determines which checks will be run
against a [legal person](http://docs.griffin.com) as part of a
[verification](http://docs.griffin.com)
name: Workflows
- description: >-
Reliance onboarding allows you to create and submit an application on
behalf of your customer, using information about them you have already
collected. [For more information see our reliance onboarding
guide](http://docs.griffin.com).
name: Reliance onboarding
- description: >-
The transaction resource represents any form of activity in a bank account
that results in a change to the account’s balance. Transactions can be
categorised by their type (`balance-change-origin-type`). Here are some
common types of bank transactions:
1. **Payment**: Sending funds to, or receiving funds from, another bank account.
2. **Fee**: Charges applied to the bank account by Griffin.
3. **Interest**: An amount charged on borrowed money, or paid to the account holder on deposited funds.
name: Transactions
- name: Pooled account membership
- name: Events
- name: Decisions
- description: >-
The organization resource represents your company and acts as a container
for the majority of other resources, including [legal
persons](http://docs.griffin.com) and [bank
accounts](http://docs.griffin.com).
When you register for an account with Griffin, a new
[organization](http://docs.griffin.com) is created alongside your
[user](http://docs.griffin.com) account (unless you have received an
[invitation](http://docs.griffin.com) to join an existing organization).
Your [user](http://docs.griffin.com) account is associated with an
[organization](http://docs.griffin.com) via a
[membership](http://docs.griffin.com).
Your [organization](http://docs.griffin.com) can be in one of two modes:
- `test-mode` for organizations created when you sign up for the sandbox.
- `live-mode` for when you go live with Griffin.
Learn more about [sandbox vs. live mode](http://docs.griffin.com).
name: Organizations
- description: >-
Users represent individuals who use the Griffin platform. A user must have
a [membership](http://docs.griffin.com) in at least one
[organization](http://docs.griffin.com), and may have memberships in
multiple organizations.
name: Users
- description: >-
Invitations enable [users](http://docs.griffin.com) to create new
[memberships](http://docs.griffin.com) for their
[organization](http://docs.griffin.com).
The new membership is only created once when the invitation is accepted.
If the `email-address` provided is linked to an existing user, the
invitation will create a membership for that user.
This does not affect any other memberships the user may have.
If the `email-address` is not linked to an existing user, the invitee will
be prompted to set up a Griffin account when they accept the invitation.
When a new membership is created, the invited user is assigned the
[role](http://docs.griffin.com) with the most limited set of capabilities
by default.
name: Invitations
- name: Navigation
- name: Connectivity
- name: Companies House
- name: Legal person history
- name: Getting started
- name: Customer verifications
paths:
/v0/index:
get:
tags:
- Navigation
summary: Index
operationId: Navigation_globalPathsFetch
description: >-
Contains various global URL paths. Follow `api-key-url` to discover your
`organization-url`.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NavigationGlobalPathsFetchResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
/v0/ping:
get:
tags:
- Connectivity
summary: Ping
operationId: Connectivity_checkConnection
security: []
description: Check your connection to the Griffin API.
responses:
'204':
description: No content
/v0/admissions/{admission-id}:
get:
tags:
- Payments
summary: Get payment admission
operationId: Payments_getAdmission
description: Yields an admission.
parameters:
- required: true
name: admission-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsGetAdmissionResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'403':
description: ''
'404':
description: ''
/v0/api-keys/{api-key-id}:
get:
tags:
- API keys
summary: Get API key
operationId: ApiKeys_getKeyDetails
description: Returns the API key without `api-key-secret`.
parameters:
- required: true
name: api-key-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeysGetKeyDetailsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
delete:
tags:
- API keys
summary: Delete API key
operationId: ApiKeys_removeApiKey
description: Deletes the API Key. This operation cannot be undone.
parameters:
- required: true
name: api-key-id
in: path
schema:
type: string
responses:
'204':
description: ''
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/bank/accounts/{bank-account-id}:
get:
tags:
- Bank accounts
summary: Get bank account
operationId: BankAccounts_getAccount
description: Fetch a bank account
parameters:
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
headers:
Location:
description: The URL of the bank account
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsGetAccountResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
patch:
tags:
- Bank accounts
operationId: BankAccounts_updateBankAccount
description: Update a bank account
parameters:
- required: true
name: bank-account-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsUpdateBankAccountRequest'
required: true
responses:
'200':
description: ''
headers:
Location:
description: The URL of the bank account
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsUpdateBankAccountResponse'
'400':
description: >-
Responds with bad-request if the body does not conform to the
schema.
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/bank/accounts/{bank-account-id}/actions/close:
post:
tags:
- Bank accounts
operationId: BankAccounts_closeAccount
description: Close a bank account
parameters:
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
headers:
Location:
description: The URL of the bank account
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsCloseAccountResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: >-
An error occurred when trying to close the bank account. See
[https://docs.griffin.com/docs/errors/account-close](https://docs.griffin.com/docs/errors/account-close)
for details.
/v0/bank/accounts/{bank-account-id}/admissions:
get:
tags:
- Payments
summary: List bank account admissions
operationId: Payments_listBankAccountAdmissions
description: Lists admissions targeting a bank account
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: ''
description: >-
Return only resources with a created-at less than or equal to the
given timestamp.
in: query
name: filter[created-at][lte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at less than the given
timestamp.
in: query
name: filter[created-at][lt]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than or equal to the
given timestamp.
in: query
name: filter[created-at][gte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than the given
timestamp.
in: query
name: filter[created-at][gt]
required: false
schema:
type: string
format: date-time
- title: ''
description: ''
in: query
name: filter[admission-status][in]
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: admission-status
description: Specifies the progress of the inbound payment.
enum:
- processing
- returned
- delivered
type: string
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsListBankAccountAdmissionsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/bank/accounts/{bank-account-id}/membership:
get:
tags:
- Pooled account membership
summary: List legal person in a pooled account membership
operationId: PooledAccountMembership_listLegalPersons
description: List legal persons in a pooled account membership
parameters:
- title: ''
description: >-
For each member returned, include its legal person details, latest
verification (if one exists), and/or latest risk rating (if one
exists) in the response under the `included` attribute.
in: query
name: include
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: ''
enum:
- latest-risk-rating
- legal-person
- latest-verification
type: string
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/PooledAccountMembershipListLegalPersonsResponse
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'403':
description: ''
'404':
description: ''
/v0/bank/accounts/{bank-account-id}/membership-updates:
post:
tags:
- Pooled account membership
summary: Manage pooled account members
operationId: PooledAccountMembership_manageLegalPersons
description: >-
Add and update the legal persons in a pooled account membership. Limited
to 2000 legal persons per operation.
parameters:
- required: true
name: bank-account-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/PooledAccountMembershipManageLegalPersonsRequest
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/PooledAccountMembershipManageLegalPersonsResponse
'400':
description: >-
Responds with bad-request if the body does not conform to the
schema.
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'403':
description: ''
'404':
description: ''
'422':
description: ''
/v0/bank/accounts/{bank-account-id}/payments:
get:
tags:
- Payments
summary: List bank account payments
operationId: Payments_getBankAccountPayments
description: Lists payments made from a bank account.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: ''
description: >-
Return only resources with a created-at less than or equal to the
given timestamp.
in: query
name: filter[created-at][lte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at less than the given
timestamp.
in: query
name: filter[created-at][lt]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than or equal to the
given timestamp.
in: query
name: filter[created-at][gte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than the given
timestamp.
in: query
name: filter[created-at][gt]
required: false
schema:
type: string
format: date-time
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsGetBankAccountPaymentsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
post:
tags:
- Payments
summary: Create payment
operationId: Payments_createRequest
description: Registers a new payment request for the bank account
parameters:
- required: true
name: bank-account-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsCreateRequestRequest'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsCreateRequestResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: >-
An error occurred when trying to create the payment. See
[https://docs.griffin.com/docs/errors/payment](https://docs.griffin.com/docs/errors/payment)
for details.
'500':
description: ''
/v0/bank/accounts/{bank-account-id}/submissions:
get:
tags:
- Payments
summary: List bank account submissions
operationId: Payments_listSubmissions
description: Lists submissions originating from a bank account
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: ''
description: ''
in: query
name: filter[submission-status][in]
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: submission-status
description: Specifies the progress of the outbound payment.
enum:
- failed
- processing
- returned
- delivered
type: string
- title: ''
description: >-
Return only resources with a created-at less than or equal to the
given timestamp.
in: query
name: filter[created-at][lte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at less than the given
timestamp.
in: query
name: filter[created-at][lt]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than or equal to the
given timestamp.
in: query
name: filter[created-at][gte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than the given
timestamp.
in: query
name: filter[created-at][gt]
required: false
schema:
type: string
format: date-time
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsListSubmissionsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/bank/accounts/{bank-account-id}/transactions:
get:
tags:
- Transactions
summary: List transactions
operationId: Transactions_listBalanceChanges
description: Lists balance changes on a bank account.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: ''
description: >-
For each transaction returned, include its payment (if one exists)
in the response under the `included` attribute.
in: query
name: include
required: false
schema:
type: string
enum:
- payment
- title: ''
description: >-
Return only resources with a created-at less than or equal to the
given timestamp.
in: query
name: filter[post-datetime][lte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at less than the given
timestamp.
in: query
name: filter[post-datetime][lt]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than or equal to the
given timestamp.
in: query
name: filter[post-datetime][gte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only resources with a created-at greater than the given
timestamp.
in: query
name: filter[post-datetime][gt]
required: false
schema:
type: string
format: date-time
- required: true
name: bank-account-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsListBalanceChangesResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/bank/transactions/{transaction-id}:
get:
tags:
- Transactions
summary: Get transaction
operationId: Transactions_getTransactionById
description: Yields a bank account transaction
parameters:
- required: true
name: transaction-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsGetTransactionByIdResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/companies-house/companies/{company-number}:
get:
tags:
- Companies House
summary: Lookup company
operationId: CompaniesHouse_getCompanyDetails
description: >-
Lookup Companies House company by company number. Includes information
about the company, its directors, and persons with significant control.
parameters:
- description: UK Companies House company number
example: '10842931'
in: path
name: company-number
required: true
schema:
type: string
minLength: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesHouseGetCompanyDetailsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'500':
description: ''
'502':
description: ''
/v0/events/{event-id}:
get:
tags:
- Events
operationId: Events_getEvent
description: Get an event
parameters:
- required: true
name: event-id
in: path
schema:
type: string
responses:
'200':
description: Fetch an event
content:
application/json:
schema:
$ref: '#/components/schemas/EventsGetEventResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
/v0/legal-persons/{legal-person-id}:
get:
tags:
- Legal persons
summary: Get legal person
operationId: LegalPersons_getLegalPerson
description: Yields the legal-person.
parameters:
- required: true
name: legal-person-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonsGetLegalPersonResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
put:
tags:
- Legal persons
summary: Update legal person
operationId: LegalPersons_updateLegalPerson
description: Updates the legal-person.
parameters:
- required: true
name: legal-person-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonsUpdateLegalPersonRequest'
required: true
responses:
'200':
description: ''
headers:
Location:
description: The location of the updated legal-person of type individual
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonsUpdateLegalPersonResponse'
'400':
description: >-
Responds with bad-request if the body does not conform to the
schema.
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: ''
/v0/legal-persons/{legal-person-id}/bank/payees:
get:
tags:
- Payees
summary: List legal person payees
operationId: Payees_listLegalPersonPayees
description: Lists payees belonging to the legal person.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: legal-person-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayeesListLegalPersonPayeesResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
post:
tags:
- Payees
summary: Create payee
operationId: Payees_registerNewPayee
description: Registers a new payee for the customer
parameters:
- required: true
name: legal-person-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PayeesRegisterNewPayeeRequest'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayeesRegisterNewPayeeResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/legal-persons/{legal-person-id}/claims:
get:
tags:
- Claims
summary: List claims
operationId: Claims_getAllClaims
description: Yields a list of all current claims about this Legal Person.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: legal-person-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimsGetAllClaimsResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
post:
tags:
- Claims
summary: Create claim
operationId: Claims_createNewClaim
description: Creates a new claim about a Legal Person.
parameters:
- required: true
name: legal-person-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimsCreateNewClaimRequest'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimsCreateNewClaimResponse'
'400':
description: >-
Responds with bad-request if the body does not conform to the
schema.
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'422':
description: ''
/v0/legal-persons/{legal-person-id}/decisions:
get:
tags:
- Decisions
summary: List decisions
operationId: Decisions_listForLegalPerson
description: Lists all decisions for the given legal-person.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: legal-person-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionsListForLegalPersonResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
post:
tags:
- Decisions
summary: Create decision
operationId: Decisions_createDecision
description: >-
Creates a decision against the legal person.
The provided verification must have a `verification-status` of
`checks-complete`, otherwise a 422 is served.
When a decision is successfully created, the legal person's
`application-status` is updated accordingly.
Multiple decisions may be made against the same legal person.
parameters:
- required: true
name: legal-person-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionsCreateDecisionRequest'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionsCreateDecisionResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'403':
description: ''
'404':
description: ''
'422':
description: ''
'500':
description: ''
'503':
description: ''
/v0/legal-persons/{legal-person-id}/history:
get:
tags:
- Legal person history
operationId: LegalPersonHistory_listEvents
description: Lists history of events for the given legal person.
parameters:
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: legal-person-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonHistoryListEventsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/legal-persons/{legal-person-id}/verifications:
get:
tags:
- Verifications
summary: List verifications for a legal person
operationId: Verifications_listForLegalPerson
description: List verifications for the given legal person.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: legal-person-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationsListForLegalPersonResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
post:
tags:
- Verifications
summary: Perform verification of a legal person
operationId: Verifications_initiateVerification
description: >-
Initiates verification of the subject legal person.
The request body must include a `workflow-url` to determine checks to be
performed by the verification. The workflow specified determines which
claims
must exist for the subject legal person, as identified in the request
URL, and any
associated legal persons (i.e. directors and people with significant
control of a
corporation).
These claims can be found in the `required-claim-types` field on a
[Workflow](http://docs.griffin.com).
---
Once a verification is created, the system will perform checks on the
claim details.
The status of check processing is indicated by the `verification-status`
in the response body.
Initially it will be `pending`, and will transition through
`in-progress` to a final status of `checks-complete`.
A `verification-status` of `failed` indicates something went wrong
during check processing.
You can initiate another verification to retry the check processing.
parameters:
- required: true
name: legal-person-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationsInitiateVerificationRequest'
required: true
responses:
'201':
description: The created verification
headers:
Location:
description: The URL of the verification
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationsInitiateVerificationResponse'
'400':
description: 'Bad Request: specific error details will be provided, if available'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: 'Not Found: An associated legal person or workflow does not exist'
'409':
description: 'Conflict: An existing verification is in-flight'
'422':
description: >-
Unprocessable Entity: specific error details will be provided, if
available
'500':
description: 'Internal Server Error: please contact support@griffin.com'
'502':
description: 'Bad Gateway: An error occurred with an external service integration'
/v0/memberships/{membership-id}:
get:
tags:
- Memberships
summary: Get membership
operationId: Memberships_getMembershipInfo
description: >-
Returns the [user's](http://docs.griffin.com)
[membership](http://docs.griffin.com) information.
parameters:
- required: true
name: membership-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MembershipsGetMembershipInfoResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
delete:
tags:
- Memberships
summary: Delete membership
operationId: Memberships_removeMember
description: >-
Removes a [user](http://docs.griffin.com) from an
[organization](http://docs.griffin.com).
parameters:
- required: true
name: membership-id
in: path
schema:
type: string
responses:
'204':
description: ''
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/memberships/{membership-id}/roles:
get:
tags:
- Roles
summary: List membership roles
operationId: Roles_getMembershipRoles
description: >-
Returns the [roles](http://docs.griffin.com) assigned to this
[membership](http://docs.griffin.com).
parameters:
- required: true
name: membership-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RolesGetMembershipRolesResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
put:
tags:
- Roles
summary: Update role
operationId: Roles_assignMembershipRoles
description: >-
Assigns [roles](http://docs.griffin.com) to the
[membership](http://docs.griffin.com).
A 422 is served if you provide a role that is not in the
[Organisations](http://docs.griffin.com) `"available-roles"`.
parameters:
- required: true
name: membership-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RolesAssignMembershipRolesRequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RolesAssignMembershipRolesResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: ''
/v0/onboarding/applications/{onboarding-application-id}:
get:
tags:
- Reliance onboarding
summary: Get onboarding application
operationId: RelianceOnboarding_getApplication
description: Fetch an onboarding application.
parameters:
- required: true
name: onboarding-application-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RelianceOnboardingGetApplicationResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/organizations/{organization-id}:
get:
tags:
- Organizations
summary: Get organization
operationId: Organizations_getDetails
description: Yields the organization details
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
headers:
Location:
description: The URL of the organization
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationsGetDetailsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/organizations/{organization-id}/api-keys:
get:
tags:
- API keys
summary: List API keys
operationId: ApiKeys_listActiveKeys
description: List all active API keys in your organization.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeysListActiveKeysResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
post:
tags:
- API keys
summary: Create API Key
operationId: ApiKeys_createKey
description: Create a new API key. This is the only time `api-key-secret` is shown.
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeysCreateKeyRequest'
required: true
responses:
'201':
description: ''
headers:
Location:
description: The URL of the created API key
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeysCreateKeyResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'409':
description: ''
/v0/organizations/{organization-id}/bank/accounts:
get:
tags:
- Bank accounts
summary: List bank accounts
operationId: BankAccounts_list
description: >-
Yields a list of all bank accounts under the control of this
Organization.
parameters:
- title: ''
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [beneficiary](http://docs.griffin.com) of the account.
in: query
name: filter[beneficiary][eq]
required: false
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
schema:
type: string
- title: ''
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [owner](http://docs.griffin.com) of the account.
in: query
name: filter[owner][eq]
required: false
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
schema:
type: string
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: ''
description: >-
For each bank account returned, include its owner and/or beneficiary
in the response under the `included.legal-persons` attribute.
in: query
name: include
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: account-party
type: string
enum:
- beneficiary
- owner
- title: ''
description: ''
in: query
name: filter[account-status][in][]
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: account-status
description: >-
Shows the status of the account. An account can be moved between
statuses during its lifecycle. The status value affects the
operations that you can perform. An account must be `"open"` to
be fully operational.
enum:
- closing
- open
- closed
- opening
type: string
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- display-name
- created-at
- '-display-name'
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: ''
description: >-
Specifies whether the bank account has restrictions applied by
Griffin.
in: query
name: filter[account-restricted][in][]
required: false
schema:
type: boolean
- title: ''
description: >-
Specifies whether the bank account holds funds belonging to multiple
beneficiaries.
in: query
name: filter[pooled-funds][eq]
required: false
schema:
type: boolean
- title: ''
description: ''
in: query
name: filter[bank-product-type][in][]
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: bank-product-type
description: >-
Specifies the type of bank account. (For more detail on bank
account types, see our guide for [creating a bank
account](http://docs.griffin.com).)
enum:
- savings-account
- client-money-account
- safeguarding-account
- operational-account
type: string
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsListResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
post:
tags:
- Bank accounts
summary: Open bank account
operationId: BankAccounts_createNewAccount
description: Open a new bank account
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsCreateNewAccountRequest'
required: true
responses:
'201':
description: ''
headers:
Location:
description: The URL of the created bank account
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccountsCreateNewAccountResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: ''
/v0/organizations/{organization-id}/events:
get:
tags:
- Events
operationId: Events_getAllOrganizationEvents
description: List all events for an organization
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: ''
description: >-
The type of webhook event. Usually has the form
{resource}-{operation}, e.g. payment-updated
in: query
name: filter[event-type][eq]
required: false
schema:
type: string
enum:
- decision-created
- payment-created
- transaction-created
- verification-updated
- admission-updated
- verification-created
- account-status-updated
- submission-created
- test-event
- admission-created
- account-status-created
- submission-updated
- title: ''
description: >-
Return only events with a created-at less than or equal to the given
timestamp.
in: query
name: filter[created-at][lte]
required: false
schema:
type: string
format: date-time
- title: ''
description: Return only events with a created-at less than the given timestamp.
in: query
name: filter[created-at][lt]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only events with a created-at greater than or equal to the
given timestamp.
in: query
name: filter[created-at][gte]
required: false
schema:
type: string
format: date-time
- title: ''
description: >-
Return only events with a created-at greater than the given
timestamp.
in: query
name: filter[created-at][gt]
required: false
schema:
type: string
format: date-time
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: Fetch all organization events
content:
application/json:
schema:
$ref: '#/components/schemas/EventsGetAllOrganizationEventsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
/v0/organizations/{organization-id}/invitations:
post:
tags:
- Invitations
summary: Create invitation
operationId: Invitations_sendEmail
description: >-
`POST` creates a new invitation to the organization.
Sends an email invitation to join the `organization` to the specified
`email-address`.
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvitationsSendEmailRequest'
required: true
responses:
'201':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'409':
description: ''
'422':
description: ''
/v0/organizations/{organization-id}/legal-persons:
get:
tags:
- Legal persons
summary: List legal persons
operationId: LegalPersons_listLegalPersons
description: >-
Returns a paginated list of all legal persons for the given
organization.
By default, results are sorted descending by `created-at` (newest
first). To sort ascending by `created-at`, provide a `?sort=created-at`
query parameter.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-status-changed-at'
- status-changed-at
- '-created-at'
- created-at
- title: ''
description: >-
For each legal person returned, include its latest verification (if
one exists), and/or its latest risk rating (if one exists) in the
response under the `included` attribute.
in: query
name: include
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: ''
enum:
- latest-risk-rating
- latest-verification
type: string
- title: ''
description: Return only legal persons with the given application-status.
in: query
name: filter[application-status][eq]
required: false
schema:
type: string
enum:
- referred
- errored
- declined
- submitted
- accepted
- title: ''
description: Return only legal persons with the given attributes.
in: query
name: filter[has][]
required: false
x-allOf:
- {}
- {}
style: form
explode: false
schema:
type: array
items:
title: ''
enum:
- application-status
type: string
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonsListLegalPersonsResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
post:
tags:
- Legal persons
summary: Create legal person
operationId: LegalPersons_createNewLegalPerson
description: >-
Creates a new Legal Person. A collection of
[Claims](http://docs.griffin.com) may be provided.
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonsCreateNewLegalPersonRequest'
required: true
responses:
'201':
description: ''
headers:
Location:
description: The URL of the created legal-person
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LegalPersonsCreateNewLegalPersonResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: ''
/v0/organizations/{organization-id}/memberships:
get:
tags:
- Memberships
summary: List organization memberships
operationId: Memberships_listOrganizationMemberships
description: >-
Returns this [organization's](http://docs.griffin.com)
[memberships](http://docs.griffin.com).
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/MembershipsListOrganizationMembershipsResponse
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
/v0/organizations/{organization-id}/onboarding/applications:
post:
tags:
- Reliance onboarding
summary: Create an onboarding application
operationId: RelianceOnboarding_createApplication
description: |-
Create an onboarding application and submit it for processing.
The request body must include a `workflow-url` to determine checks to be performed by the verification.
The workflow specified determines which claims must exist for the subject profile, and any related profile (i.e. directors and people with significant control of a corporation).
---
At the moment we only support 3 reliance workflows: Reliance LTD Company, Reliance Individual and Reliance Sole Trader.
You need to provide different claims depending on the type of customer you wish to onboard via reliance.
| LTD Company | Individual | Sole trader |
| ----------- | ---------- | ----------- |
| Subject profile:
`uk-company-register`
`trading-address`
`reliance-verification`
Related profiles:
`individual-identity`
`individual-residence`
`reliance-verification` | Subject profile:
`individual-identity`
`individual-residence`
`reliance-verification` | Subject profile:
`business-name`
`individual-identity`
`individual-residence`
`reliance-verification` |
[For more information see our reliance onboarding guide](http://docs.griffin.com).
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RelianceOnboardingCreateApplicationRequest'
required: true
responses:
'201':
description: The created application
headers:
Location:
description: The URL of the application
schema:
type: string
content:
application/json:
schema:
$ref: >-
#/components/schemas/RelianceOnboardingCreateApplicationResponse
'400':
description: >-
Responds with bad-request if the body does not conform to the
schema.
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'422':
description: >-
Unprocessable Entity: specific error details will be provided, if
available
/v0/organizations/{organization-id}/webhooks:
get:
tags:
- Webhooks
operationId: Webhooks_getAll
description: Get all webhooks for the organization
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksGetAllResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
post:
tags:
- Webhooks
operationId: Webhooks_createWebhook
description: Create a webhook
parameters:
- required: true
name: organization-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksCreateWebhookRequest'
required: true
responses:
'201':
description: The newly-created webhook
headers:
Location:
description: The URL of the webhook
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksCreateWebhookResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'422':
description: ''
/v0/organizations/{organization-id}/workflows:
get:
tags:
- Workflows
summary: List organization workflows
operationId: Workflows_listOrganizationWorkflows
description: >-
Lists workflows for use when creating a
[verification](http://docs.griffin.com).
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: organization-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/WorkflowsListOrganizationWorkflowsResponse
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/payees/{payee-id}:
get:
tags:
- Payees
summary: Get payee
operationId: Payees_getDetails
description: Yields payee details
parameters:
- required: true
name: payee-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayeesGetDetailsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
patch:
tags:
- Payees
summary: Update payee
operationId: Payees_updatePayee
description: >-
Updates an existing payee.
A payee can be deactivated by updating the `payee-status` of an active
payee to `deactivated`. Any attempt to create or submit a payment to a
deactivated payee will fail.
A 422 is served when attempting to deactivate an already-deactivated
payee.
parameters:
- required: true
name: payee-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PayeesUpdatePayeeRequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PayeesUpdatePayeeResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'422':
description: ''
'500':
description: ''
/v0/payments/{payment-id}:
get:
tags:
- Payments
summary: Get payment
operationId: Payments_getDetails
description: Yields payment details
parameters:
- required: true
name: payment-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsGetDetailsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/payments/{payment-id}/admissions:
get:
tags:
- Payments
summary: List payment admissions
operationId: Payments_listAdmissions
description: >-
Lists admissions for a payment. A payment may have at most one
admission.
parameters:
- required: true
name: payment-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsListAdmissionsResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/payments/{payment-id}/submissions:
get:
tags:
- Payments
summary: List payment submissions
operationId: Payments_listSubmissions
description: >-
Lists submissions for a payment. The presence of a submission means that
the payment has been submitted.
parameters:
- required: true
name: payment-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsListSubmissions200Response'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
post:
tags:
- Payments
summary: Submit payment
operationId: Payments_submitPaymentSubmission
description: Submits a previously created payment for execution.
parameters:
- required: true
name: payment-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsSubmitPaymentSubmissionRequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsSubmitPaymentSubmissionResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
'410':
description: ''
'422':
description: >-
An error occurred when trying to submit the payment. See
[https://docs.griffin.com/docs/errors/payment](https://docs.griffin.com/docs/errors/payment)
for details.
/v0/roles:
get:
tags:
- Roles
summary: List roles
operationId: Roles_listAllRoles
security: []
description: Yields a list of all Role resources.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RolesListAllRolesResponse'
/v0/roles/{role-id}:
get:
tags:
- Roles
summary: Get role
operationId: Roles_getRole
security: []
description: Yields the Role resource.
parameters:
- required: true
name: role-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RolesGetRoleResponse'
'400':
description: ''
'404':
description: ''
/v0/submissions/{submission-id}:
get:
tags:
- Payments
summary: Get payment submission
operationId: Payments_getSubmission
description: Yields a submission.
parameters:
- required: true
name: submission-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentsGetSubmissionResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'403':
description: ''
'404':
description: ''
/v0/users/{user-id}:
get:
tags:
- Users
summary: Get user
operationId: Users_getUserResource
description: Get the User resource for the current user.
parameters:
- required: true
name: user-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UsersGetUserResourceResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/users/{user-id}/api-keys:
get:
tags:
- API keys
summary: List API keys
operationId: ApiKeys_listActiveKeys
description: List all your active API keys.
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: user-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeysListActiveKeys200Response'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
/v0/users/{user-id}/memberships:
get:
tags:
- Memberships
summary: List user memberships
operationId: Memberships_listUserMemberships
description: >-
Returns this [user's](http://docs.griffin.com)
[memberships](http://docs.griffin.com).
parameters:
- title: ''
description: ''
in: query
name: sort
required: false
schema:
type: string
enum:
- '-created-at'
- created-at
- title: size
description: ''
x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
name: page[size]
required: false
in: query
schema:
type: integer
format: int64
minimum: 1
maximum: 200
- title: after
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[after]
required: false
in: query
schema:
type: string
format: byte
- title: before
description: A base64 encoded opaque string returned in paginated responses.
example: djE6NL0DfDTSUk67KJKCi-L5Zg
name: page[before]
required: false
in: query
schema:
type: string
format: byte
- required: true
name: user-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MembershipsListUserMembershipsResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
/v0/verifications/{verification-id}:
get:
tags:
- Verifications
summary: Get verification
operationId: Verifications_getVerification
description: Fetch the verification.
parameters:
- required: true
name: verification-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationsGetVerificationResponse'
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/webhooks/{webhook-id}:
get:
tags:
- Webhooks
operationId: Webhooks_getWebhook
description: Fetch a webhook
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksGetWebhookResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
delete:
tags:
- Webhooks
operationId: Webhooks_deleteWebhook
description: Delete a webhook
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
responses:
'204':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
patch:
tags:
- Webhooks
operationId: Webhooks_updateWebhook
description: Update a webhook
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksUpdateWebhookRequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksUpdateWebhookResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/webhooks/{webhook-id}/actions/activate:
post:
tags:
- Webhooks
operationId: Webhooks_activateAction
description: Activate a webhook
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksActivateActionResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/webhooks/{webhook-id}/actions/deactivate:
post:
tags:
- Webhooks
operationId: Webhooks_deactivateAction
description: Deactivate a webhook
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksDeactivateActionResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
/v0/webhooks/{webhook-id}/actions/test:
get:
tags:
- Webhooks
operationId: Webhooks_getLatestTestStatus
description: Get the status of the latest test event
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksGetLatestTestStatusResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
post:
tags:
- Webhooks
operationId: Webhooks_sendTestEvent
description: Send a test event to the webhook
parameters:
- required: true
name: webhook-id
in: path
schema:
type: string
responses:
'201':
description: ''
headers:
Location:
description: The URL to check the progress of the test
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksSendTestEventResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'409':
description: An existing test is in-flight
/v0/workflows/{workflow-id}:
get:
tags:
- Workflows
summary: Get workflow
operationId: Workflows_getWorkflow
description: Fetch the workflow.
parameters:
- required: true
name: workflow-id
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetWorkflowResponse'
'401':
description: Requires an API key to continue
headers:
www-authenticate:
description: Returns `GriffinSession` if no valid authentication is found.
schema:
type: string
'404':
description: ''
components:
securitySchemes:
api-key-auth:
description: |-
API token authentication.
It should follow the format: `GriffinAPIKey g-test-MyKey-XXXXXXX`
type: apiKey
in: header
name: Authorization
schemas:
BankAccountsUpdateBankAccountRequest:
title: request-update-bank-account
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
required:
- display-name
PooledAccountMembershipManageLegalPersonsRequest:
title: request-pooled-account-membership-updates
type: object
properties:
additions:
type: array
items:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
deletions:
type: array
items:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
required:
- additions
- deletions
PaymentsCreateRequestRequest:
title: request-create-payment
type: object
properties:
creditor:
title: creditor
type: object
properties: {}
required:
- creditor-type
anyOf:
- title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
creditor-type:
enum:
- payee
type: string
required:
- payee-url
- creditor-type
- title: griffin-bank-account
type: object
properties:
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
creditor-type:
enum:
- griffin-bank-account
type: string
required:
- account-url
- creditor-type
- title: uk-domestic
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
creditor-type:
enum:
- uk-domestic
type: string
required:
- account-holder
- account-number
- account-number-code
- bank-id
- bank-id-code
- creditor-type
payment-amount:
title: payment-amount
description: >-
Compound value representing both the currency and amount of money
being sent.
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
x-allOf:
- title: money-amount
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
- x-allOf:
- x-allOf:
- {}
- {}
- {}
payment-reference:
title: payment-reference
description: Free-text field to help identify and categorise payments.
type: string
maxLength: 35
example: test reference
minLength: 1
required:
- creditor
- payment-amount
LegalPersonsUpdateLegalPersonRequest:
title: request-update-legal-person
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
required:
- display-name
PayeesRegisterNewPayeeRequest:
title: request-create-bank-payee
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
required:
- account-holder
- account-number
- bank-id
ClaimsCreateNewClaimRequest:
title: claim
type: object
properties: {}
required:
- claim-type
anyOf:
- title: mobile-number
type: object
properties:
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- mobile-number
type: string
required:
- mobile-number
- claim-type
- title: individual-identity
type: object
properties:
date-of-birth:
title: date-of-birth
description: ISO 8601 formatted date.
format: date
type: string
given-name:
type: string
surname:
type: string
middle-name:
type: string
claim-type:
enum:
- individual-identity
type: string
required:
- date-of-birth
- given-name
- surname
- claim-type
- title: sole-trader
type: object
properties:
trading-name:
type: string
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- sole-trader
type: string
required:
- trading-name
- trading-address
- claim-type
- title: uk-company-register
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- uk-company-register
type: string
city:
type: string
building-name:
type: string
street-name:
type: string
entity-name:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
building-number:
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
required:
- street-name
- city
- postal-code
- country-code
- entity-name
- entity-registration-number
- corporation-type
- claim-type
- title: individual-income
type: object
properties:
income:
title: income
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- individual-income
type: string
required:
- income
- claim-type
- title: initial-deposit
type: object
properties:
initial-deposit:
title: initial-deposit
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- initial-deposit
type: string
required:
- initial-deposit
- claim-type
- title: international-payments-countries
type: object
properties:
international-payments-countries:
title: international-payments-countries
description: |-
List of country codes for payments received
from UK accounts that are, in full or in part,
funded from international sources. If the
account does not receive payments from
internationally-funded sources, then leave
the collection empty.
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-payments-countries
type: string
required:
- international-payments-countries
- claim-type
- title: company-telephone-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- company-telephone-number
type: string
required:
- telephone-number
- claim-type
- title: person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- person-with-significant-control
type: string
required:
- legal-person-url
- ownership-percent
- claim-type
- title: company-email-address
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- company-email-address
type: string
required:
- email-address
- claim-type
- title: tax-residency
type: object
properties:
tax-residency:
title: tax-residency
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- tax-residency
type: string
required:
- tax-residency
- claim-type
- title: uk-financial-services-register
type: object
properties:
uk-regulatory-permissions:
type: array
items:
title: uk-regulatory-permission
type: string
enum:
- electronic-money-institution
- payment-institution
- client-money
- bank
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
claim-type:
enum:
- uk-financial-services-register
type: string
required:
- uk-regulatory-permissions
- claim-type
- title: business-description
type: object
properties:
business-description:
title: business-description
type: string
minLength: 1
claim-type:
enum:
- business-description
type: string
required:
- business-description
- claim-type
- title: individual-sources-of-funds
type: object
properties:
individual-sources-of-funds:
type: array
items:
title: individual-source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- individual-sources-of-funds
type: string
required:
- individual-sources-of-funds
- claim-type
- title: nominal-person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- nominal-person-with-significant-control
type: string
required:
- legal-person-url
- claim-type
- title: business-address
type: object
properties:
business-address:
title: business-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- business-address
type: string
required:
- business-address
- claim-type
- title: employment
type: object
properties:
claim-type:
enum:
- employment
type: string
required:
- employment-status
- claim-type
anyOf:
- title: self-employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| | `alternative-and-complementary-medicine-practitioner` |
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` | `civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` | `lecturer-or-professor`
|
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` | `entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager` |
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- self-employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: retired
type: object
properties:
employment-status:
enum:
- retired
type: string
required:
- employment-status
- title: unemployed
type: object
properties:
employment-status:
enum:
- unemployed
type: string
required:
- employment-status
- title: employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| | `alternative-and-complementary-medicine-practitioner` |
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` | `civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` | `lecturer-or-professor`
|
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` | `entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager` |
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: annual-turnover
type: object
properties:
annual-turnover:
title: annual-turnover
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- annual-turnover
type: string
required:
- annual-turnover
- claim-type
- title: purposes-of-account
type: object
properties:
purposes-of-account:
type: array
items:
title: purpose-of-account
type: string
enum:
- short-term-investment
- long-term-investment
- safeguarding
- staff-payroll
- client-money
- business-expenses
- receiving-payments
- operational-spend
uniqueItems: true
claim-type:
enum:
- purposes-of-account
type: string
required:
- purposes-of-account
- claim-type
- title: sic-codes
type: object
properties:
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
claim-type:
enum:
- sic-codes
type: string
required:
- sic-codes
- claim-type
- title: international-operations-countries
type: object
properties:
international-operations-countries:
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-operations-countries
type: string
required:
- international-operations-countries
- claim-type
- title: sources-of-funds
type: object
properties:
sources-of-funds:
type: array
items:
title: source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- business-income
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- sources-of-funds
type: string
required:
- sources-of-funds
- claim-type
- title: contact-details
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- contact-details
type: string
required:
- email-address
- claim-type
- title: reliance-verification
type: object
properties:
reliance-verification-methods:
type: array
items:
title: reliance-verification-method
type: string
enum:
- manual-document
- physical
- electronic
- manual-biometric
uniqueItems: true
reliance-verification-standard:
title: reliance-verification-standard
type: string
enum:
- jmlsg
claim-type:
enum:
- reliance-verification
type: string
required:
- reliance-verification-methods
- reliance-verification-standard
- claim-type
- title: business-name
type: object
properties:
business-name:
type: string
claim-type:
enum:
- business-name
type: string
required:
- business-name
- claim-type
- title: individual-purposes-of-account
type: object
properties:
individual-purposes-of-account:
type: array
items:
title: individual-purpose-of-account
type: string
enum:
- savings
- bills-and-repayment
- everyday-spending
uniqueItems: true
claim-type:
enum:
- individual-purposes-of-account
type: string
required:
- individual-purposes-of-account
- claim-type
- title: nationality
type: object
properties:
nationality:
title: nationality
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- nationality
type: string
required:
- nationality
- claim-type
- title: trading-name
type: object
properties:
trading-name:
type: string
claim-type:
enum:
- trading-name
type: string
required:
- trading-name
- claim-type
- title: social-media
type: object
properties:
social-media:
title: social-media
type: string
minLength: 1
claim-type:
enum:
- social-media
type: string
required:
- social-media
- claim-type
- title: trading-address
type: object
properties:
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- trading-address
type: string
required:
- trading-address
- claim-type
- title: company-website
type: object
properties:
website-url:
type: string
x-allOf:
- type: string
- {}
claim-type:
enum:
- company-website
type: string
required:
- website-url
- claim-type
- title: director
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
claim-type:
enum:
- director
type: string
required:
- legal-person-url
- claim-type
- title: alternative-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- alternative-number
type: string
required:
- telephone-number
- claim-type
- title: cash-payments
type: object
properties:
cash-payments?:
title: cash-payments?
description: >-
Attestation that funds generated from cash are (true) or are not
(false)
accepted.
type: boolean
claim-type:
enum:
- cash-payments
type: string
required:
- cash-payments?
- claim-type
- title: tax-identification-number
type: object
properties:
tax-identification-number:
title: tax-identification-number
type: string
minLength: 1
claim-type:
enum:
- tax-identification-number
type: string
required:
- tax-identification-number
- claim-type
- title: individual-residence
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- individual-residence
type: string
required:
- street-name
- city
- postal-code
- country-code
- claim-type
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
DecisionsCreateDecisionRequest:
title: request-create-decision
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-notes:
title: decision-notes
description: Free-text field to explain the reasons behind the decision.
type: string
required:
- verification-url
- decision-outcome
- decision-notes
VerificationsInitiateVerificationRequest:
title: request-create-verification
type: object
properties:
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
required:
- workflow-url
RolesAssignMembershipRolesRequest:
title: request-update-membership-roles
type: object
properties:
role-urls:
type: array
items:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- role-urls
ApiKeysCreateKeyRequest:
title: request-create-api-key
type: object
properties:
api-key-name:
title: api-key-name
description: The name of the API Key. Cannot contain whitespace.
minLength: 1
required:
- api-key-name
BankAccountsCreateNewAccountRequest:
title: request-open-bank-account
type: object
properties: {}
required:
- bank-product-type
anyOf:
- title: savings-account
type: object
properties:
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
savings-type:
title: savings-type
description: Specifies the type of savings account.
enum:
- easy-access
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
bank-product-type:
enum:
- savings-account
type: string
required:
- owner-url
- savings-type
- bank-product-type
- title: client-money-account
type: object
properties:
bank-product-type:
enum:
- client-money-account
type: string
required:
- pooled-funds
- bank-product-type
anyOf:
- title: 'true'
type: object
properties:
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
enum:
- true
type: boolean
required:
- client-money-type
- pooled-funds
x-allOf:
- type: object
properties:
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
required:
- client-money-type
- {}
- title: 'false'
type: object
properties:
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [beneficiary](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
enum:
- false
type: boolean
required:
- beneficiary-url
- client-money-type
- pooled-funds
x-allOf:
- type: object
properties:
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [beneficiary](http://docs.griffin.com) of
the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
required:
- beneficiary-url
- client-money-type
- {}
- title: safeguarding-account
type: object
properties:
bank-product-type:
enum:
- safeguarding-account
type: string
required:
- pooled-funds
- bank-product-type
anyOf:
- title: 'true'
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
enum:
- true
type: boolean
x-allOf:
- type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
- {}
required:
- pooled-funds
- title: 'false'
type: object
properties:
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [beneficiary](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
enum:
- false
type: boolean
required:
- beneficiary-url
- pooled-funds
x-allOf:
- type: object
properties:
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [beneficiary](http://docs.griffin.com) of
the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
required:
- beneficiary-url
- {}
- title: operational-account
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
bank-product-type:
enum:
- operational-account
type: string
required:
- bank-product-type
InvitationsSendEmailRequest:
title: request-create-invitation
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
required:
- email-address
LegalPersonsCreateNewLegalPersonRequest:
title: request-create-legal-person
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
legal-person-type:
title: legal-person-type
description: Specifies if the legal person is an `individual` or a `corporation`.
enum:
- individual
- corporation
type: string
claims:
type: array
items:
title: claim
type: object
properties: {}
required:
- claim-type
anyOf:
- title: mobile-number
type: object
properties:
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- mobile-number
type: string
required:
- mobile-number
- claim-type
- title: individual-identity
type: object
properties:
date-of-birth:
title: date-of-birth
description: ISO 8601 formatted date.
format: date
type: string
given-name:
type: string
surname:
type: string
middle-name:
type: string
claim-type:
enum:
- individual-identity
type: string
required:
- date-of-birth
- given-name
- surname
- claim-type
- title: sole-trader
type: object
properties:
trading-name:
type: string
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- sole-trader
type: string
required:
- trading-name
- trading-address
- claim-type
- title: uk-company-register
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- uk-company-register
type: string
city:
type: string
building-name:
type: string
street-name:
type: string
entity-name:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
building-number:
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
required:
- street-name
- city
- postal-code
- country-code
- entity-name
- entity-registration-number
- corporation-type
- claim-type
- title: individual-income
type: object
properties:
income:
title: income
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- individual-income
type: string
required:
- income
- claim-type
- title: initial-deposit
type: object
properties:
initial-deposit:
title: initial-deposit
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- initial-deposit
type: string
required:
- initial-deposit
- claim-type
- title: international-payments-countries
type: object
properties:
international-payments-countries:
title: international-payments-countries
description: |-
List of country codes for payments received
from UK accounts that are, in full or in part,
funded from international sources. If the
account does not receive payments from
internationally-funded sources, then leave
the collection empty.
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-payments-countries
type: string
required:
- international-payments-countries
- claim-type
- title: company-telephone-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- company-telephone-number
type: string
required:
- telephone-number
- claim-type
- title: person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- person-with-significant-control
type: string
required:
- legal-person-url
- ownership-percent
- claim-type
- title: company-email-address
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- company-email-address
type: string
required:
- email-address
- claim-type
- title: tax-residency
type: object
properties:
tax-residency:
title: tax-residency
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- tax-residency
type: string
required:
- tax-residency
- claim-type
- title: uk-financial-services-register
type: object
properties:
uk-regulatory-permissions:
type: array
items:
title: uk-regulatory-permission
type: string
enum:
- electronic-money-institution
- payment-institution
- client-money
- bank
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
claim-type:
enum:
- uk-financial-services-register
type: string
required:
- uk-regulatory-permissions
- claim-type
- title: business-description
type: object
properties:
business-description:
title: business-description
type: string
minLength: 1
claim-type:
enum:
- business-description
type: string
required:
- business-description
- claim-type
- title: individual-sources-of-funds
type: object
properties:
individual-sources-of-funds:
type: array
items:
title: individual-source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- individual-sources-of-funds
type: string
required:
- individual-sources-of-funds
- claim-type
- title: nominal-person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- nominal-person-with-significant-control
type: string
required:
- legal-person-url
- claim-type
- title: business-address
type: object
properties:
business-address:
title: business-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- business-address
type: string
required:
- business-address
- claim-type
- title: employment
type: object
properties:
claim-type:
enum:
- employment
type: string
required:
- employment-status
- claim-type
anyOf:
- title: self-employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- self-employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: retired
type: object
properties:
employment-status:
enum:
- retired
type: string
required:
- employment-status
- title: unemployed
type: object
properties:
employment-status:
enum:
- unemployed
type: string
required:
- employment-status
- title: employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: annual-turnover
type: object
properties:
annual-turnover:
title: annual-turnover
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- annual-turnover
type: string
required:
- annual-turnover
- claim-type
- title: purposes-of-account
type: object
properties:
purposes-of-account:
type: array
items:
title: purpose-of-account
type: string
enum:
- short-term-investment
- long-term-investment
- safeguarding
- staff-payroll
- client-money
- business-expenses
- receiving-payments
- operational-spend
uniqueItems: true
claim-type:
enum:
- purposes-of-account
type: string
required:
- purposes-of-account
- claim-type
- title: sic-codes
type: object
properties:
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
claim-type:
enum:
- sic-codes
type: string
required:
- sic-codes
- claim-type
- title: international-operations-countries
type: object
properties:
international-operations-countries:
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-operations-countries
type: string
required:
- international-operations-countries
- claim-type
- title: sources-of-funds
type: object
properties:
sources-of-funds:
type: array
items:
title: source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- business-income
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- sources-of-funds
type: string
required:
- sources-of-funds
- claim-type
- title: contact-details
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- contact-details
type: string
required:
- email-address
- claim-type
- title: reliance-verification
type: object
properties:
reliance-verification-methods:
type: array
items:
title: reliance-verification-method
type: string
enum:
- manual-document
- physical
- electronic
- manual-biometric
uniqueItems: true
reliance-verification-standard:
title: reliance-verification-standard
type: string
enum:
- jmlsg
claim-type:
enum:
- reliance-verification
type: string
required:
- reliance-verification-methods
- reliance-verification-standard
- claim-type
- title: business-name
type: object
properties:
business-name:
type: string
claim-type:
enum:
- business-name
type: string
required:
- business-name
- claim-type
- title: individual-purposes-of-account
type: object
properties:
individual-purposes-of-account:
type: array
items:
title: individual-purpose-of-account
type: string
enum:
- savings
- bills-and-repayment
- everyday-spending
uniqueItems: true
claim-type:
enum:
- individual-purposes-of-account
type: string
required:
- individual-purposes-of-account
- claim-type
- title: nationality
type: object
properties:
nationality:
title: nationality
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- nationality
type: string
required:
- nationality
- claim-type
- title: trading-name
type: object
properties:
trading-name:
type: string
claim-type:
enum:
- trading-name
type: string
required:
- trading-name
- claim-type
- title: social-media
type: object
properties:
social-media:
title: social-media
type: string
minLength: 1
claim-type:
enum:
- social-media
type: string
required:
- social-media
- claim-type
- title: trading-address
type: object
properties:
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- trading-address
type: string
required:
- trading-address
- claim-type
- title: company-website
type: object
properties:
website-url:
type: string
x-allOf:
- type: string
- {}
claim-type:
enum:
- company-website
type: string
required:
- website-url
- claim-type
- title: director
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
claim-type:
enum:
- director
type: string
required:
- legal-person-url
- claim-type
- title: alternative-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- alternative-number
type: string
required:
- telephone-number
- claim-type
- title: cash-payments
type: object
properties:
cash-payments?:
title: cash-payments?
description: >-
Attestation that funds generated from cash are (true) or
are not (false)
accepted.
type: boolean
claim-type:
enum:
- cash-payments
type: string
required:
- cash-payments?
- claim-type
- title: tax-identification-number
type: object
properties:
tax-identification-number:
title: tax-identification-number
type: string
minLength: 1
claim-type:
enum:
- tax-identification-number
type: string
required:
- tax-identification-number
- claim-type
- title: individual-residence
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- individual-residence
type: string
required:
- street-name
- city
- postal-code
- country-code
- claim-type
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
required:
- display-name
- legal-person-type
RelianceOnboardingCreateApplicationRequest:
title: request-create-onboarding-application
type: object
properties:
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
subject-profile:
title: subject-profile
description: The subject profile to be onboarded.
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
claims:
type: array
items:
title: claim
type: object
properties: {}
required:
- claim-type
anyOf:
- title: mobile-number
type: object
properties:
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- mobile-number
type: string
required:
- mobile-number
- claim-type
- title: individual-identity
type: object
properties:
date-of-birth:
title: date-of-birth
description: ISO 8601 formatted date.
format: date
type: string
given-name:
type: string
surname:
type: string
middle-name:
type: string
claim-type:
enum:
- individual-identity
type: string
required:
- date-of-birth
- given-name
- surname
- claim-type
- title: sole-trader
type: object
properties:
trading-name:
type: string
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- sole-trader
type: string
required:
- trading-name
- trading-address
- claim-type
- title: uk-company-register
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- uk-company-register
type: string
city:
type: string
building-name:
type: string
street-name:
type: string
entity-name:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
building-number:
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For
UK companies that's the Companies House company
number.
type: string
minLength: 1
required:
- street-name
- city
- postal-code
- country-code
- entity-name
- entity-registration-number
- corporation-type
- claim-type
- title: individual-income
type: object
properties:
income:
title: income
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- individual-income
type: string
required:
- income
- claim-type
- title: initial-deposit
type: object
properties:
initial-deposit:
title: initial-deposit
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- initial-deposit
type: string
required:
- initial-deposit
- claim-type
- title: international-payments-countries
type: object
properties:
international-payments-countries:
title: international-payments-countries
description: |-
List of country codes for payments received
from UK accounts that are, in full or in part,
funded from international sources. If the
account does not receive payments from
internationally-funded sources, then leave
the collection empty.
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-payments-countries
type: string
required:
- international-payments-countries
- claim-type
- title: company-telephone-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- company-telephone-number
type: string
required:
- telephone-number
- claim-type
- title: person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- person-with-significant-control
type: string
required:
- legal-person-url
- ownership-percent
- claim-type
- title: company-email-address
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- company-email-address
type: string
required:
- email-address
- claim-type
- title: tax-residency
type: object
properties:
tax-residency:
title: tax-residency
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- tax-residency
type: string
required:
- tax-residency
- claim-type
- title: uk-financial-services-register
type: object
properties:
uk-regulatory-permissions:
type: array
items:
title: uk-regulatory-permission
type: string
enum:
- electronic-money-institution
- payment-institution
- client-money
- bank
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For
UK companies that's the Companies House company
number.
type: string
minLength: 1
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
claim-type:
enum:
- uk-financial-services-register
type: string
required:
- uk-regulatory-permissions
- claim-type
- title: business-description
type: object
properties:
business-description:
title: business-description
type: string
minLength: 1
claim-type:
enum:
- business-description
type: string
required:
- business-description
- claim-type
- title: individual-sources-of-funds
type: object
properties:
individual-sources-of-funds:
type: array
items:
title: individual-source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- individual-sources-of-funds
type: string
required:
- individual-sources-of-funds
- claim-type
- title: nominal-person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- nominal-person-with-significant-control
type: string
required:
- legal-person-url
- claim-type
- title: business-address
type: object
properties:
business-address:
title: business-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- business-address
type: string
required:
- business-address
- claim-type
- title: employment
type: object
properties:
claim-type:
enum:
- employment
type: string
required:
- employment-status
- claim-type
anyOf:
- title: self-employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of
occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher`
|
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` |
`nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner`
|
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer`
|
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` |
`customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer`
|
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` |
`stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` |
`geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- self-employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: retired
type: object
properties:
employment-status:
enum:
- retired
type: string
required:
- employment-status
- title: unemployed
type: object
properties:
employment-status:
enum:
- unemployed
type: string
required:
- employment-status
- title: employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of
occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher`
|
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` |
`nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner`
|
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer`
|
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` |
`customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer`
|
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` |
`stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` |
`geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: annual-turnover
type: object
properties:
annual-turnover:
title: annual-turnover
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- annual-turnover
type: string
required:
- annual-turnover
- claim-type
- title: purposes-of-account
type: object
properties:
purposes-of-account:
type: array
items:
title: purpose-of-account
type: string
enum:
- short-term-investment
- long-term-investment
- safeguarding
- staff-payroll
- client-money
- business-expenses
- receiving-payments
- operational-spend
uniqueItems: true
claim-type:
enum:
- purposes-of-account
type: string
required:
- purposes-of-account
- claim-type
- title: sic-codes
type: object
properties:
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
claim-type:
enum:
- sic-codes
type: string
required:
- sic-codes
- claim-type
- title: international-operations-countries
type: object
properties:
international-operations-countries:
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-operations-countries
type: string
required:
- international-operations-countries
- claim-type
- title: sources-of-funds
type: object
properties:
sources-of-funds:
type: array
items:
title: source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- business-income
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- sources-of-funds
type: string
required:
- sources-of-funds
- claim-type
- title: contact-details
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- contact-details
type: string
required:
- email-address
- claim-type
- title: reliance-verification
type: object
properties:
reliance-verification-methods:
type: array
items:
title: reliance-verification-method
type: string
enum:
- manual-document
- physical
- electronic
- manual-biometric
uniqueItems: true
reliance-verification-standard:
title: reliance-verification-standard
type: string
enum:
- jmlsg
claim-type:
enum:
- reliance-verification
type: string
required:
- reliance-verification-methods
- reliance-verification-standard
- claim-type
- title: business-name
type: object
properties:
business-name:
type: string
claim-type:
enum:
- business-name
type: string
required:
- business-name
- claim-type
- title: individual-purposes-of-account
type: object
properties:
individual-purposes-of-account:
type: array
items:
title: individual-purpose-of-account
type: string
enum:
- savings
- bills-and-repayment
- everyday-spending
uniqueItems: true
claim-type:
enum:
- individual-purposes-of-account
type: string
required:
- individual-purposes-of-account
- claim-type
- title: nationality
type: object
properties:
nationality:
title: nationality
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- nationality
type: string
required:
- nationality
- claim-type
- title: trading-name
type: object
properties:
trading-name:
type: string
claim-type:
enum:
- trading-name
type: string
required:
- trading-name
- claim-type
- title: social-media
type: object
properties:
social-media:
title: social-media
type: string
minLength: 1
claim-type:
enum:
- social-media
type: string
required:
- social-media
- claim-type
- title: trading-address
type: object
properties:
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- trading-address
type: string
required:
- trading-address
- claim-type
- title: company-website
type: object
properties:
website-url:
type: string
x-allOf:
- type: string
- {}
claim-type:
enum:
- company-website
type: string
required:
- website-url
- claim-type
- title: director
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
claim-type:
enum:
- director
type: string
required:
- legal-person-url
- claim-type
- title: alternative-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- alternative-number
type: string
required:
- telephone-number
- claim-type
- title: cash-payments
type: object
properties:
cash-payments?:
title: cash-payments?
description: >-
Attestation that funds generated from cash are (true)
or are not (false)
accepted.
type: boolean
claim-type:
enum:
- cash-payments
type: string
required:
- cash-payments?
- claim-type
- title: tax-identification-number
type: object
properties:
tax-identification-number:
title: tax-identification-number
type: string
minLength: 1
claim-type:
enum:
- tax-identification-number
type: string
required:
- tax-identification-number
- claim-type
- title: individual-residence
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- individual-residence
type: string
required:
- street-name
- city
- postal-code
- country-code
- claim-type
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
required:
- display-name
- claims
related-profiles:
title: related-profiles
description: >-
A list profiles related to the subject (e.g. directors, person with
significant control).
type: array
items:
title: related-profile
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
subject-association:
title: subject-association
description: >-
The relationship with the subject profile. Choose at least one
of the subject associations.
type: object
properties:
director:
title: director
type: object
properties:
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
psc:
title: psc
type: object
properties:
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager:
title: senior-manager
type: object
properties: {}
x-allOf:
- type: object
properties:
director:
title: director
type: object
properties:
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
psc:
title: psc
type: object
properties:
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of
the corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager:
title: senior-manager
type: object
properties: {}
- {}
claims:
type: array
items:
title: claim
type: object
properties: {}
required:
- claim-type
anyOf:
- title: mobile-number
type: object
properties:
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- mobile-number
type: string
required:
- mobile-number
- claim-type
- title: individual-identity
type: object
properties:
date-of-birth:
title: date-of-birth
description: ISO 8601 formatted date.
format: date
type: string
given-name:
type: string
surname:
type: string
middle-name:
type: string
claim-type:
enum:
- individual-identity
type: string
required:
- date-of-birth
- given-name
- surname
- claim-type
- title: sole-trader
type: object
properties:
trading-name:
type: string
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- sole-trader
type: string
required:
- trading-name
- trading-address
- claim-type
- title: uk-company-register
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- uk-company-register
type: string
city:
type: string
building-name:
type: string
street-name:
type: string
entity-name:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- >-
further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
building-number:
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register.
For UK companies that's the Companies House company
number.
type: string
minLength: 1
required:
- street-name
- city
- postal-code
- country-code
- entity-name
- entity-registration-number
- corporation-type
- claim-type
- title: individual-income
type: object
properties:
income:
title: income
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- individual-income
type: string
required:
- income
- claim-type
- title: initial-deposit
type: object
properties:
initial-deposit:
title: initial-deposit
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- initial-deposit
type: string
required:
- initial-deposit
- claim-type
- title: international-payments-countries
type: object
properties:
international-payments-countries:
title: international-payments-countries
description: |-
List of country codes for payments received
from UK accounts that are, in full or in part,
funded from international sources. If the
account does not receive payments from
internationally-funded sources, then leave
the collection empty.
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-payments-countries
type: string
required:
- international-payments-countries
- claim-type
- title: company-telephone-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- company-telephone-number
type: string
required:
- telephone-number
- claim-type
- title: person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- person-with-significant-control
type: string
required:
- legal-person-url
- ownership-percent
- claim-type
- title: company-email-address
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- company-email-address
type: string
required:
- email-address
- claim-type
- title: tax-residency
type: object
properties:
tax-residency:
title: tax-residency
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- tax-residency
type: string
required:
- tax-residency
- claim-type
- title: uk-financial-services-register
type: object
properties:
uk-regulatory-permissions:
type: array
items:
title: uk-regulatory-permission
type: string
enum:
- electronic-money-institution
- payment-institution
- client-money
- bank
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register.
For UK companies that's the Companies House company
number.
type: string
minLength: 1
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- >-
further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
claim-type:
enum:
- uk-financial-services-register
type: string
required:
- uk-regulatory-permissions
- claim-type
- title: business-description
type: object
properties:
business-description:
title: business-description
type: string
minLength: 1
claim-type:
enum:
- business-description
type: string
required:
- business-description
- claim-type
- title: individual-sources-of-funds
type: object
properties:
individual-sources-of-funds:
type: array
items:
title: individual-source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- individual-sources-of-funds
type: string
required:
- individual-sources-of-funds
- claim-type
- title: nominal-person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- nominal-person-with-significant-control
type: string
required:
- legal-person-url
- claim-type
- title: business-address
type: object
properties:
business-address:
title: business-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- business-address
type: string
required:
- business-address
- claim-type
- title: employment
type: object
properties:
claim-type:
enum:
- employment
type: string
required:
- employment-status
- claim-type
anyOf:
- title: self-employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of
occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` |
`butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` |
`nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` |
`street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` |
`social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist`
|
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` |
`customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| |
`electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker`
|
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker`
|
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor`
|
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` |
`stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` |
`geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- self-employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: retired
type: object
properties:
employment-status:
enum:
- retired
type: string
required:
- employment-status
- title: unemployed
type: object
properties:
employment-status:
enum:
- unemployed
type: string
required:
- employment-status
- title: employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of
occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` |
`butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` |
`nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` |
`street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` |
`social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist`
|
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` |
`customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| |
`electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker`
|
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker`
|
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor`
|
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` |
`stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` |
`geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: annual-turnover
type: object
properties:
annual-turnover:
title: annual-turnover
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- annual-turnover
type: string
required:
- annual-turnover
- claim-type
- title: purposes-of-account
type: object
properties:
purposes-of-account:
type: array
items:
title: purpose-of-account
type: string
enum:
- short-term-investment
- long-term-investment
- safeguarding
- staff-payroll
- client-money
- business-expenses
- receiving-payments
- operational-spend
uniqueItems: true
claim-type:
enum:
- purposes-of-account
type: string
required:
- purposes-of-account
- claim-type
- title: sic-codes
type: object
properties:
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
claim-type:
enum:
- sic-codes
type: string
required:
- sic-codes
- claim-type
- title: international-operations-countries
type: object
properties:
international-operations-countries:
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-operations-countries
type: string
required:
- international-operations-countries
- claim-type
- title: sources-of-funds
type: object
properties:
sources-of-funds:
type: array
items:
title: source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- business-income
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- sources-of-funds
type: string
required:
- sources-of-funds
- claim-type
- title: contact-details
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- contact-details
type: string
required:
- email-address
- claim-type
- title: reliance-verification
type: object
properties:
reliance-verification-methods:
type: array
items:
title: reliance-verification-method
type: string
enum:
- manual-document
- physical
- electronic
- manual-biometric
uniqueItems: true
reliance-verification-standard:
title: reliance-verification-standard
type: string
enum:
- jmlsg
claim-type:
enum:
- reliance-verification
type: string
required:
- reliance-verification-methods
- reliance-verification-standard
- claim-type
- title: business-name
type: object
properties:
business-name:
type: string
claim-type:
enum:
- business-name
type: string
required:
- business-name
- claim-type
- title: individual-purposes-of-account
type: object
properties:
individual-purposes-of-account:
type: array
items:
title: individual-purpose-of-account
type: string
enum:
- savings
- bills-and-repayment
- everyday-spending
uniqueItems: true
claim-type:
enum:
- individual-purposes-of-account
type: string
required:
- individual-purposes-of-account
- claim-type
- title: nationality
type: object
properties:
nationality:
title: nationality
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- nationality
type: string
required:
- nationality
- claim-type
- title: trading-name
type: object
properties:
trading-name:
type: string
claim-type:
enum:
- trading-name
type: string
required:
- trading-name
- claim-type
- title: social-media
type: object
properties:
social-media:
title: social-media
type: string
minLength: 1
claim-type:
enum:
- social-media
type: string
required:
- social-media
- claim-type
- title: trading-address
type: object
properties:
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- trading-address
type: string
required:
- trading-address
- claim-type
- title: company-website
type: object
properties:
website-url:
type: string
x-allOf:
- type: string
- {}
claim-type:
enum:
- company-website
type: string
required:
- website-url
- claim-type
- title: director
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
claim-type:
enum:
- director
type: string
required:
- legal-person-url
- claim-type
- title: alternative-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- alternative-number
type: string
required:
- telephone-number
- claim-type
- title: cash-payments
type: object
properties:
cash-payments?:
title: cash-payments?
description: >-
Attestation that funds generated from cash are
(true) or are not (false)
accepted.
type: boolean
claim-type:
enum:
- cash-payments
type: string
required:
- cash-payments?
- claim-type
- title: tax-identification-number
type: object
properties:
tax-identification-number:
title: tax-identification-number
type: string
minLength: 1
claim-type:
enum:
- tax-identification-number
type: string
required:
- tax-identification-number
- claim-type
- title: individual-residence
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- individual-residence
type: string
required:
- street-name
- city
- postal-code
- country-code
- claim-type
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
required:
- display-name
- subject-association
- claims
required:
- workflow-url
- subject-profile
WebhooksCreateWebhookRequest:
title: request-create-webhook
type: object
properties:
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- webhook-destination-url
PayeesUpdatePayeeRequest:
title: request-update-bank-payee
type: object
properties:
payee-status:
title: payee-status
enum:
- deactivated
type: string
required:
- payee-status
x-allOf:
- type: object
properties:
payee-status:
title: payee-status
description: >-
The status of the payee; you can only make payments to active
payees.
enum:
- deactivated
- active
type: string
required:
- payee-status
- {}
PaymentsSubmitPaymentSubmissionRequest:
title: request-create-payment-submission
type: object
properties:
payment-scheme:
title: payment-scheme
description: Specifies the scheme over which a payment is executed.
enum:
- fps
type: string
WebhooksUpdateWebhookRequest:
title: request-update-webhook
type: object
properties:
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
NavigationGlobalPathsFetchResponse:
title: index
type: object
properties:
organizations-url:
title: organizations-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations
users-url:
title: users-url
type: string
example: /v0/users
roles-url:
title: roles-url
type: string
example: /v0/roles
session-url:
title: session-url
type: string
example: /v0/session
api-key-url:
title: api-key-url
description: The resource path for the API key
type: string
example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
required:
- organizations-url
- users-url
- roles-url
PaymentsGetAdmissionResponse:
title: admission
type: object
properties:
admission-status:
title: admission-status
description: Specifies the progress of the inbound payment.
enum:
- processing
- returned
- delivered
type: string
admission-scheme-information:
title: admission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as assigned
by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
admission-url:
title: admission-url
type: string
example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA
required:
- admission-status
- admission-scheme-information
- payment-url
- created-at
- admission-url
ApiKeysGetKeyDetailsResponse:
title: api-key
type: object
properties:
api-key-url:
title: api-key-url
description: The resource path for the API key
type: string
example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
api-key-name:
title: api-key-name
description: The immutable display name for the API key
pattern: ^[a-zA-z0-9-_]+
maxLength: 64
example: buildserver
minLength: 1
api-key-live?:
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- api-key-url
- api-key-name
- api-key-live?
- organization-url
- user-url
- created-at
BankAccountsGetAccountResponse:
title: bank-account
type: object
properties:
account-submissions-url:
title: account-submissions-url
description: >-
Link to the [payment submissions](http://docs.griffin.com) debiting
from this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions
account-restricted:
title: account-restricted
description: >-
Specifies whether the bank account has restrictions applied by
Griffin.
type: boolean
account-payments-url:
title: account-payments-url
description: >-
Link to the [payments](http://docs.griffin.com) associated with this
account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments
pooled-account-memberships-url:
title: pooled-account-memberships-url
description: >-
Link to the list of [pool members](http://docs.griffin.com)
associated with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership
account-admissions-url:
title: account-admissions-url
description: >-
Link to the [payment admissions](http://docs.griffin.com) crediting
to this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions
bank-product-type:
title: bank-product-type
description: >-
Specifies the type of bank account. (For more detail on bank account
types, see our guide for [creating a bank
account](http://docs.griffin.com).)
enum:
- savings-account
- client-money-account
- safeguarding-account
- operational-account
type: string
display-name:
title: display-name
description: The mutable display name for the bank account
type: string
minLength: 1
maxLength: 64
example: Reserve a/c
controller-url:
title: controller-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [controller](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
title: pooled-funds
description: >-
Specifies whether the bank account holds funds belonging to multiple
beneficiaries.
type: boolean
account-status:
title: account-status
description: >-
Shows the status of the account. An account can be moved between
statuses during its lifecycle. The status value affects the
operations that you can perform. An account must be `"open"` to be
fully operational.
enum:
- closing
- open
- closed
- opening
type: string
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [owner](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
close-account-url:
title: close-account-url
description: Link to the endpoint that enables account closure for this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close
available-balance:
title: available-balance
description: Shows the [available balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
pooled-account-membership-updates-url:
title: pooled-account-membership-updates-url
description: Link to manage [pooled account membership](http://docs.griffin.com).
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates
bank-addresses:
title: bank-addresses
description: >-
Shows a collection of public addresses which uniquely identify the
account. Any one of these can be used to pay into the account.
type: array
items:
title: bank-address
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
required:
- account-holder
- bank-id-code
- bank-id
- account-number
- account-number-code
account-transactions-url:
title: account-transactions-url
description: >-
Link to the [transactions](http://docs.griffin.com) associated with
this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [beneficiary](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
savings-type:
title: savings-type
description: Specifies the type of savings account.
enum:
- easy-access
type: string
required:
- account-balance
- available-balance
- account-payments-url
- account-admissions-url
- account-submissions-url
- account-transactions-url
- account-url
- close-account-url
- owner-url
- controller-url
- display-name
- account-restricted
- account-status
- bank-product-type
- pooled-funds
- created-at
BankAccountsUpdateBankAccountResponse:
title: bank-account
type: object
properties:
account-submissions-url:
title: account-submissions-url
description: >-
Link to the [payment submissions](http://docs.griffin.com) debiting
from this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions
account-restricted:
title: account-restricted
description: >-
Specifies whether the bank account has restrictions applied by
Griffin.
type: boolean
account-payments-url:
title: account-payments-url
description: >-
Link to the [payments](http://docs.griffin.com) associated with this
account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments
pooled-account-memberships-url:
title: pooled-account-memberships-url
description: >-
Link to the list of [pool members](http://docs.griffin.com)
associated with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership
account-admissions-url:
title: account-admissions-url
description: >-
Link to the [payment admissions](http://docs.griffin.com) crediting
to this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions
bank-product-type:
title: bank-product-type
description: >-
Specifies the type of bank account. (For more detail on bank account
types, see our guide for [creating a bank
account](http://docs.griffin.com).)
enum:
- savings-account
- client-money-account
- safeguarding-account
- operational-account
type: string
display-name:
title: display-name
description: The mutable display name for the bank account
type: string
minLength: 1
maxLength: 64
example: Reserve a/c
controller-url:
title: controller-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [controller](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
title: pooled-funds
description: >-
Specifies whether the bank account holds funds belonging to multiple
beneficiaries.
type: boolean
account-status:
title: account-status
description: >-
Shows the status of the account. An account can be moved between
statuses during its lifecycle. The status value affects the
operations that you can perform. An account must be `"open"` to be
fully operational.
enum:
- closing
- open
- closed
- opening
type: string
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [owner](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
close-account-url:
title: close-account-url
description: Link to the endpoint that enables account closure for this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close
available-balance:
title: available-balance
description: Shows the [available balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
pooled-account-membership-updates-url:
title: pooled-account-membership-updates-url
description: Link to manage [pooled account membership](http://docs.griffin.com).
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates
bank-addresses:
title: bank-addresses
description: >-
Shows a collection of public addresses which uniquely identify the
account. Any one of these can be used to pay into the account.
type: array
items:
title: bank-address
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
required:
- account-holder
- bank-id-code
- bank-id
- account-number
- account-number-code
account-transactions-url:
title: account-transactions-url
description: >-
Link to the [transactions](http://docs.griffin.com) associated with
this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [beneficiary](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
savings-type:
title: savings-type
description: Specifies the type of savings account.
enum:
- easy-access
type: string
required:
- account-balance
- available-balance
- account-payments-url
- account-admissions-url
- account-submissions-url
- account-transactions-url
- account-url
- close-account-url
- owner-url
- controller-url
- display-name
- account-restricted
- account-status
- bank-product-type
- pooled-funds
- created-at
BankAccountsCloseAccountResponse:
title: bank-account
type: object
properties:
account-submissions-url:
title: account-submissions-url
description: >-
Link to the [payment submissions](http://docs.griffin.com) debiting
from this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions
account-restricted:
title: account-restricted
description: >-
Specifies whether the bank account has restrictions applied by
Griffin.
type: boolean
account-payments-url:
title: account-payments-url
description: >-
Link to the [payments](http://docs.griffin.com) associated with this
account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments
pooled-account-memberships-url:
title: pooled-account-memberships-url
description: >-
Link to the list of [pool members](http://docs.griffin.com)
associated with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership
account-admissions-url:
title: account-admissions-url
description: >-
Link to the [payment admissions](http://docs.griffin.com) crediting
to this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions
bank-product-type:
title: bank-product-type
description: >-
Specifies the type of bank account. (For more detail on bank account
types, see our guide for [creating a bank
account](http://docs.griffin.com).)
enum:
- savings-account
- client-money-account
- safeguarding-account
- operational-account
type: string
display-name:
title: display-name
description: The mutable display name for the bank account
type: string
minLength: 1
maxLength: 64
example: Reserve a/c
controller-url:
title: controller-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [controller](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
title: pooled-funds
description: >-
Specifies whether the bank account holds funds belonging to multiple
beneficiaries.
type: boolean
account-status:
title: account-status
description: >-
Shows the status of the account. An account can be moved between
statuses during its lifecycle. The status value affects the
operations that you can perform. An account must be `"open"` to be
fully operational.
enum:
- closing
- open
- closed
- opening
type: string
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [owner](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
close-account-url:
title: close-account-url
description: Link to the endpoint that enables account closure for this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close
available-balance:
title: available-balance
description: Shows the [available balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
pooled-account-membership-updates-url:
title: pooled-account-membership-updates-url
description: Link to manage [pooled account membership](http://docs.griffin.com).
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates
bank-addresses:
title: bank-addresses
description: >-
Shows a collection of public addresses which uniquely identify the
account. Any one of these can be used to pay into the account.
type: array
items:
title: bank-address
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
required:
- account-holder
- bank-id-code
- bank-id
- account-number
- account-number-code
account-transactions-url:
title: account-transactions-url
description: >-
Link to the [transactions](http://docs.griffin.com) associated with
this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [beneficiary](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
savings-type:
title: savings-type
description: Specifies the type of savings account.
enum:
- easy-access
type: string
required:
- account-balance
- available-balance
- account-payments-url
- account-admissions-url
- account-submissions-url
- account-transactions-url
- account-url
- close-account-url
- owner-url
- controller-url
- display-name
- account-restricted
- account-status
- bank-product-type
- pooled-funds
- created-at
PaymentsListBankAccountAdmissionsResponse:
title: admissions-paginated-response
type: object
properties:
admissions:
type: array
items:
title: admission
type: object
properties:
admission-status:
title: admission-status
description: Specifies the progress of the inbound payment.
enum:
- processing
- returned
- delivered
type: string
admission-scheme-information:
title: admission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as
assigned by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
admission-url:
title: admission-url
type: string
example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA
required:
- admission-status
- admission-scheme-information
- payment-url
- created-at
- admission-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- admissions
- links
PooledAccountMembershipListLegalPersonsResponse:
type: object
properties:
pool-members:
type: array
items:
title: pool-member
type: object
properties:
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
required:
- created-at
- legal-person-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
meta:
title: meta
type: object
properties:
page:
title: page
type: object
properties:
total:
title: total
description: >-
Total number of items. Present when the total number of
items in the full result set is less than 10,000.
type: integer
format: int64
minimum: 0
estimated-total:
title: estimated-total
type: object
properties:
at-least:
title: at-least
description: >-
Present when the total number of items in the full
result set exceeds 10,000. This indicates that the
actual number of items is at least 10,000, but the exact
total is not provided due to performance considerations.
enum:
- 10000
type: integer
included:
title: ''
description: Present only when the request uses the `include` parameter.
type: object
properties:
verifications:
type: array
items:
title: verification
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
verification-checks-url:
title: verification-checks-url
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/checks
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
verification-status:
title: verification-status
type: string
enum:
- in-progress
- pending
- checks-declined
- checks-complete
- failed
verification-risk-assessments-url:
title: verification-risk-assessments-url
type: string
example: >-
/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/risk-assessments
required:
- created-at
- legal-person-url
- verification-status
- verification-url
- verification-checks-url
risk-rating-entries:
type: array
items:
title: risk-rating-entry
type: object
properties:
risk-rating-url:
title: risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
notes:
title: notes
description: Rationale for overriding the risk rating.
type: string
minLength: 1
manually-created-by:
title: manually-created-by
description: User that triggered this event.
type: object
properties: {}
required:
- manually-created-by-type
anyOf:
- title: ops-user
type: object
properties:
manually-created-by-type:
enum:
- ops-user
type: string
required:
- manually-created-by-type
- manually-created-by-type
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
previous-risk-rating:
title: previous-risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
required:
- risk-rating-url
- risk-rating
- legal-person-url
legal-persons:
type: array
items:
title: legal-person
type: object
properties:
latest-decision:
title: latest-decision
description: The most recent [decision](http://docs.griffin.com)
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: >-
Indicates if the decision was automated or made by a
human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: >-
Free-text field to explain the reasons behind the
decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made
the decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that
made the decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
legal-person-type:
title: legal-person-type
description: >-
Specifies if the legal person is an `individual` or a
`corporation`.
enum:
- individual
- corporation
type: string
latest-risk-rating-url:
title: latest-risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
application-status:
title: application-status
description: >-
Status of the current
[application](http://docs.griffin.com)
enum:
- referred
- errored
- declined
- submitted
- accepted
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
legal-person-decisions-url:
title: legal-person-decisions-url
description: >-
Link to [decisions](http://docs.griffin.com) for this
[legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions
status-changed-at:
title: status-changed-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-claims-url:
title: legal-person-claims-url
description: >-
Link to the [claims](http://docs.griffin.com) for this
[legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims
legal-person-bank-payees-url:
title: legal-person-bank-payees-url
description: >-
Link to the [payees](http://docs.griffin.com) for this
[legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees
legal-person-verifications-url:
title: legal-person-verifications-url
description: >-
Link to all [verifications](http://docs.griffin.com) run
against this [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications
legal-person-documents-url:
title: legal-person-documents-url
description: >-
Link to all evidence documents associated with this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents
required:
- created-at
- display-name
- legal-person-decisions-url
- legal-person-documents-url
- legal-person-type
- legal-person-url
- legal-person-verifications-url
required:
- links
- pool-members
PooledAccountMembershipManageLegalPersonsResponse:
title: update-pooled-account-memberships-response
type: object
properties:
pooled-account-memberships-url:
title: pooled-account-memberships-url
description: >-
Link to the list of [pool members](http://docs.griffin.com)
associated with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership
required:
- pooled-account-memberships-url
PaymentsGetBankAccountPaymentsResponse:
title: payments-response
type: object
properties:
payments:
type: array
items:
title: payment
type: object
properties:
creditor:
title: creditor
type: object
properties: {}
required:
- creditor-type
anyOf:
- title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
creditor-type:
enum:
- payee
type: string
required:
- payee-url
- creditor-type
- title: griffin-bank-account
type: object
properties:
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
creditor-type:
enum:
- griffin-bank-account
type: string
required:
- account-url
- creditor-type
- title: uk-domestic
type: object
properties:
account-holder:
title: account-holder
description: >-
The name of the [account
holder](http://docs.griffin.com).
type: string
minLength: 1
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
creditor-type:
enum:
- uk-domestic
type: string
required:
- account-holder
- account-number
- account-number-code
- bank-id
- bank-id-code
- creditor-type
payment-direction:
title: payment-direction
description: >-
Whether the payment is moving money into or out of the
account.
enum:
- inbound-payment
- outbound-payment
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
payment-reference:
title: payment-reference
description: Free-text field to help identify and categorise payments.
type: string
maxLength: 35
example: test reference
minLength: 1
payment-amount:
title: payment-amount
description: >-
Compound value representing both the currency and amount of
money being sent.
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
x-allOf:
- title: money-amount
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
- x-allOf:
- x-allOf:
- {}
- {}
- {}
ultimate-debtor:
title: ultimate-debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
payment-admissions-url:
title: payment-admissions-url
description: Link to the endpoint for listing payment admissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions
payment-submissions-url:
title: payment-submissions-url
description: >-
Link to the endpoint for creating and listing payment
submissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions
debtor:
title: debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
required:
- created-at
- payment-amount
- debtor
- creditor
- payment-url
- payment-direction
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- payments
- links
PaymentsCreateRequestResponse:
title: payment
type: object
properties:
creditor:
title: creditor
type: object
properties: {}
required:
- creditor-type
anyOf:
- title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
creditor-type:
enum:
- payee
type: string
required:
- payee-url
- creditor-type
- title: griffin-bank-account
type: object
properties:
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
creditor-type:
enum:
- griffin-bank-account
type: string
required:
- account-url
- creditor-type
- title: uk-domestic
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
creditor-type:
enum:
- uk-domestic
type: string
required:
- account-holder
- account-number
- account-number-code
- bank-id
- bank-id-code
- creditor-type
payment-direction:
title: payment-direction
description: Whether the payment is moving money into or out of the account.
enum:
- inbound-payment
- outbound-payment
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
payment-reference:
title: payment-reference
description: Free-text field to help identify and categorise payments.
type: string
maxLength: 35
example: test reference
minLength: 1
payment-amount:
title: payment-amount
description: >-
Compound value representing both the currency and amount of money
being sent.
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
x-allOf:
- title: money-amount
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
- x-allOf:
- x-allOf:
- {}
- {}
- {}
ultimate-debtor:
title: ultimate-debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
payment-admissions-url:
title: payment-admissions-url
description: Link to the endpoint for listing payment admissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions
payment-submissions-url:
title: payment-submissions-url
description: Link to the endpoint for creating and listing payment submissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions
debtor:
title: debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
required:
- created-at
- payment-amount
- debtor
- creditor
- payment-url
- payment-direction
PaymentsListSubmissionsResponse:
title: submissions-paginated-response
type: object
properties:
submissions:
type: array
items:
title: submission
type: object
properties:
submission-status:
title: submission-status
description: Specifies the progress of the outbound payment.
enum:
- failed
- processing
- returned
- delivered
type: string
submission-scheme-information:
title: submission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as
assigned by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
scheme-status-code:
title: scheme-status-code
description: A scheme-specific code describing the current status.
type: string
minLength: 1
scheme-status-code-description:
title: scheme-status-code-description
description: >-
A human-readable description of the scheme status
code.
type: string
minLength: 1
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
submission-url:
title: submission-url
type: string
example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA
required:
- submission-status
- submission-scheme-information
- payment-url
- created-at
- submission-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- submissions
- links
TransactionsListBalanceChangesResponse:
title: ''
type: object
properties:
account-transactions:
type: array
items:
title: account-transaction
type: object
properties:
account-transaction-url:
title: account-transaction-url
description: Link to the transaction resource.
type: string
post-datetime:
title: post-datetime
description: When the transaction was posted.
format: date-time
type: string
balance-change-direction:
title: balance-change-direction
description: Specifies the direction of a balance change.
enum:
- credit
- debit
type: string
transaction-origin-type:
title: transaction-origin-type
description: >-
Specifies the origin of a balance change, for example a
payment
enum:
- interest
- deposit
- fee
- transfer
- payment
- commission
type: string
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
reference:
type: string
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
balance-change:
title: balance-change
description: Shows the account [balance change](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
required:
- account-transaction-url
- account-balance
- balance-change
- balance-change-direction
- transaction-origin-type
- post-datetime
- account-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
included:
title: ''
description: Present only when the request uses the `include` parameter.
type: object
properties:
payments:
type: array
items:
title: payment
type: object
properties:
creditor:
title: creditor
type: object
properties: {}
required:
- creditor-type
anyOf:
- title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
creditor-type:
enum:
- payee
type: string
required:
- payee-url
- creditor-type
- title: griffin-bank-account
type: object
properties:
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
creditor-type:
enum:
- griffin-bank-account
type: string
required:
- account-url
- creditor-type
- title: uk-domestic
type: object
properties:
account-holder:
title: account-holder
description: >-
The name of the [account
holder](http://docs.griffin.com).
type: string
minLength: 1
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
creditor-type:
enum:
- uk-domestic
type: string
required:
- account-holder
- account-number
- account-number-code
- bank-id
- bank-id-code
- creditor-type
payment-direction:
title: payment-direction
description: >-
Whether the payment is moving money into or out of the
account.
enum:
- inbound-payment
- outbound-payment
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
payment-reference:
title: payment-reference
description: Free-text field to help identify and categorise payments.
type: string
maxLength: 35
example: test reference
minLength: 1
payment-amount:
title: payment-amount
description: >-
Compound value representing both the currency and amount
of money being sent.
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
x-allOf:
- title: money-amount
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
- x-allOf:
- x-allOf:
- {}
- {}
- {}
ultimate-debtor:
title: ultimate-debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: >-
The name of the [account
holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
payment-admissions-url:
title: payment-admissions-url
description: Link to the endpoint for listing payment admissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions
payment-submissions-url:
title: payment-submissions-url
description: >-
Link to the endpoint for creating and listing payment
submissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions
debtor:
title: debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: >-
The name of the [account
holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
required:
- created-at
- payment-amount
- debtor
- creditor
- payment-url
- payment-direction
required:
- account-transactions
- links
TransactionsGetTransactionByIdResponse:
title: account-transaction
type: object
properties:
account-transaction-url:
title: account-transaction-url
description: Link to the transaction resource.
type: string
post-datetime:
title: post-datetime
description: When the transaction was posted.
format: date-time
type: string
balance-change-direction:
title: balance-change-direction
description: Specifies the direction of a balance change.
enum:
- credit
- debit
type: string
transaction-origin-type:
title: transaction-origin-type
description: Specifies the origin of a balance change, for example a payment
enum:
- interest
- deposit
- fee
- transfer
- payment
- commission
type: string
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
reference:
type: string
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
balance-change:
title: balance-change
description: Shows the account [balance change](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
required:
- account-transaction-url
- account-balance
- balance-change
- balance-change-direction
- transaction-origin-type
- post-datetime
- account-url
CompaniesHouseGetCompanyDetailsResponse:
title: company-information-response
type: object
properties:
company-address:
title: company-address
type: object
properties:
building-number:
type: string
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-latest-accounts:
title: date-of-latest-accounts
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
directors:
type: array
items:
title: director
type: object
properties:
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
date-of-latest-confirmation-statement:
title: date-of-latest-confirmation-statement
description: ISO 8601 formatted date.
format: date
type: string
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
company-status:
title: company-status
type: string
enum:
- dissolved
- active
- receivership
- registered
- removed
- administration
- open
- closed
- voluntary-arrangement
- liquidation
- converted-closed
- insolvency-proceedings
accounts-overdue:
type: boolean
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
persons-with-significant-control:
type: array
items:
title: person-with-significant-control
type: object
properties:
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
natures-of-control:
type: array
items:
title: nature-of-control
type: string
enum:
- >-
voting-rights-25-to-50-percent-limited-liability-partnership
- >-
right-to-appoint-and-remove-members-limited-liability-partnership
- >-
part-right-to-share-surplus-assets-75-to-100-percent-as-trust
- >-
ownership-of-shares-more-than-25-percent-registered-overseas-entity
- >-
part-right-to-share-surplus-assets-50-to-75-percent-as-trust
- >-
significant-influence-or-control-as-firm-limited-liability-partnership
- >-
part-right-to-share-surplus-assets-25-to-50-percent-as-firm
- ownership-of-shares-25-to-50-percent-as-trust
- >-
ownership-of-shares-more-than-25-percent-as-firm-registered-overseas-entity
- voting-rights-25-to-50-percent
- voting-rights-25-to-50-percent-as-firm
- >-
ownership-of-shares-more-than-25-percent-as-trust-registered-overseas-entity
- significant-influence-or-control
- >-
significant-influence-or-control-registered-overseas-entity
- >-
part-right-to-share-surplus-assets-50-to-75-percent-as-firm
- voting-rights-50-to-75-percent
- part-right-to-share-surplus-assets-25-to-50-percent
- voting-rights-50-to-75-percent-as-trust
- >-
right-to-share-surplus-assets-75-to-100-percent-as-firm-limited-liability-partnership
- right-to-appoint-and-remove-person-as-trust
- ownership-of-shares-50-to-75-percent-as-firm
- >-
voting-rights-50-to-75-percent-as-firm-limited-liability-partnership
- voting-rights-25-to-50-percent-as-trust
- >-
voting-rights-50-to-75-percent-as-trust-limited-liability-partnership
- voting-rights-75-to-100-percent
- >-
part-right-to-share-surplus-assets-75-to-100-percent-as-firm
- >-
significant-influence-or-control-limited-liability-partnership
- >-
right-to-share-surplus-assets-75-to-100-percent-limited-liability-partnership
- right-to-appoint-and-remove-directors-as-firm
- voting-rights-75-to-100-percent-as-trust
- >-
voting-rights-25-to-50-percent-as-firm-limited-liability-partnership
- >-
right-to-appoint-and-remove-directors-as-firm-registered-overseas-entity
- >-
right-to-share-surplus-assets-25-to-50-percent-as-firm-limited-liability-partnership
- ownership-of-shares-25-to-50-percent
- ownership-of-shares-75-to-100-percent-as-firm
- significant-influence-or-control-as-firm
- right-to-appoint-and-remove-directors-as-trust
- right-to-appoint-and-remove-person
- >-
significant-influence-or-control-as-trust-registered-overseas-entity
- >-
voting-rights-more-than-25-percent-as-trust-registered-overseas-entity
- >-
right-to-appoint-and-remove-directors-as-trust-registered-overseas-entity
- >-
right-to-appoint-and-remove-members-as-firm-limited-liability-partnership
- part-right-to-share-surplus-assets-75-to-100-percent
- ownership-of-shares-25-to-50-percent-as-firm
- >-
right-to-share-surplus-assets-25-to-50-percent-as-trust-limited-liability-partnership
- >-
right-to-share-surplus-assets-50-to-75-percent-limited-liability-partnership
- voting-rights-50-to-75-percent-as-firm
- part-right-to-share-surplus-assets-50-to-75-percent
- >-
right-to-appoint-and-remove-directors-registered-overseas-entity
- significant-influence-or-control-as-trust
- >-
right-to-share-surplus-assets-75-to-100-percent-as-trust-limited-liability-partnership
- ownership-of-shares-50-to-75-percent-as-trust
- >-
right-to-share-surplus-assets-50-to-75-percent-as-firm-limited-liability-partnership
- >-
voting-rights-more-than-25-percent-as-firm-registered-overseas-entity
- >-
significant-influence-or-control-as-firm-registered-overseas-entity
- ownership-of-shares-75-to-100-percent-as-trust
- ownership-of-shares-50-to-75-percent
- >-
right-to-share-surplus-assets-50-to-75-percent-as-trust-limited-liability-partnership
- >-
voting-rights-75-to-100-percent-limited-liability-partnership
- >-
voting-rights-more-than-25-percent-registered-overseas-entity
- >-
right-to-appoint-and-remove-members-as-trust-limited-liability-partnership
- ownership-of-shares-75-to-100-percent
- >-
part-right-to-share-surplus-assets-25-to-50-percent-as-trust
- >-
voting-rights-75-to-100-percent-as-trust-limited-liability-partnership
- >-
voting-rights-50-to-75-percent-limited-liability-partnership
- >-
significant-influence-or-control-as-trust-limited-liability-partnership
- >-
voting-rights-75-to-100-percent-as-firm-limited-liability-partnership
- right-to-appoint-and-remove-person-as-firm
- right-to-appoint-and-remove-directors
- >-
voting-rights-25-to-50-percent-as-trust-limited-liability-partnership
- voting-rights-75-to-100-percent-as-firm
- >-
right-to-share-surplus-assets-25-to-50-percent-limited-liability-partnership
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
given-name:
type: string
surname:
type: string
day-of-birth:
type: integer
format: int64
minimum: 1
month-of-birth:
type: integer
format: int64
minimum: 1
year-of-birth:
type: integer
format: int64
minimum: 1
required:
- display-name
- natures-of-control
- companies-house-url
confirmation-statement-overdue:
type: boolean
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK companies
that's the Companies House company number.
type: string
minLength: 1
required:
- directors
- persons-with-significant-control
- date-of-incorporation
- corporation-type
- entity-registration-number
- entity-name
- company-status
EventsGetEventResponse:
title: event
type: object
properties:
event-url:
title: event-url
description: Link to the [event](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/events/ev.ICAgICAgICBldmVudC1pZA
event-type:
title: event-type
description: >-
The type of webhook event. Usually has the form
{resource}-{operation}, e.g. payment-updated
enum:
- decision-created
- payment-created
- transaction-created
- verification-updated
- admission-updated
- verification-created
- account-status-updated
- submission-created
- test-event
- admission-created
- account-status-created
- submission-updated
type: string
event-payload:
type: object
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- event-url
- event-type
- event-payload
LegalPersonsGetLegalPersonResponse:
title: legal-person
type: object
properties:
latest-decision:
title: latest-decision
description: The most recent [decision](http://docs.griffin.com)
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: Indicates if the decision was automated or made by a human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: Free-text field to explain the reasons behind the decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
legal-person-type:
title: legal-person-type
description: Specifies if the legal person is an `individual` or a `corporation`.
enum:
- individual
- corporation
type: string
latest-risk-rating-url:
title: latest-risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
display-name:
title: display-name
description: The mutable display name for the Legal-Person
type: string
minLength: 1
maxLength: 64
example: Company name
application-status:
title: application-status
description: Status of the current [application](http://docs.griffin.com)
enum:
- referred
- errored
- declined
- submitted
- accepted
type: string
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
legal-person-decisions-url:
title: legal-person-decisions-url
description: >-
Link to [decisions](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions
status-changed-at:
title: status-changed-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-claims-url:
title: legal-person-claims-url
description: >-
Link to the [claims](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims
legal-person-bank-payees-url:
title: legal-person-bank-payees-url
description: >-
Link to the [payees](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees
legal-person-verifications-url:
title: legal-person-verifications-url
description: >-
Link to all [verifications](http://docs.griffin.com) run against
this [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications
legal-person-documents-url:
title: legal-person-documents-url
description: >-
Link to all evidence documents associated with this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents
required:
- created-at
- display-name
- legal-person-decisions-url
- legal-person-documents-url
- legal-person-type
- legal-person-url
- legal-person-verifications-url
LegalPersonsUpdateLegalPersonResponse:
title: legal-person
type: object
properties:
latest-decision:
title: latest-decision
description: The most recent [decision](http://docs.griffin.com)
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: Indicates if the decision was automated or made by a human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: Free-text field to explain the reasons behind the decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
legal-person-type:
title: legal-person-type
description: Specifies if the legal person is an `individual` or a `corporation`.
enum:
- individual
- corporation
type: string
latest-risk-rating-url:
title: latest-risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
display-name:
title: display-name
description: The mutable display name for the Legal-Person
type: string
minLength: 1
maxLength: 64
example: Company name
application-status:
title: application-status
description: Status of the current [application](http://docs.griffin.com)
enum:
- referred
- errored
- declined
- submitted
- accepted
type: string
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
legal-person-decisions-url:
title: legal-person-decisions-url
description: >-
Link to [decisions](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions
status-changed-at:
title: status-changed-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-claims-url:
title: legal-person-claims-url
description: >-
Link to the [claims](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims
legal-person-bank-payees-url:
title: legal-person-bank-payees-url
description: >-
Link to the [payees](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees
legal-person-verifications-url:
title: legal-person-verifications-url
description: >-
Link to all [verifications](http://docs.griffin.com) run against
this [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications
legal-person-documents-url:
title: legal-person-documents-url
description: >-
Link to all evidence documents associated with this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents
required:
- created-at
- display-name
- legal-person-decisions-url
- legal-person-documents-url
- legal-person-type
- legal-person-url
- legal-person-verifications-url
PayeesListLegalPersonPayeesResponse:
title: payees-response
type: object
properties:
payees:
type: array
items:
title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
payee-status:
title: payee-status
description: >-
The status of the payee; you can only make payments to active
payees.
enum:
- deactivated
- active
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- account-holder
- account-number
- bank-id
- country-code
- created-at
- legal-person-url
- payee-status
- payee-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- payees
- links
PayeesRegisterNewPayeeResponse:
title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
payee-status:
title: payee-status
description: >-
The status of the payee; you can only make payments to active
payees.
enum:
- deactivated
- active
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- account-holder
- account-number
- bank-id
- country-code
- created-at
- legal-person-url
- payee-status
- payee-url
ClaimsGetAllClaimsResponse:
title: legal-person-claims-response
type: object
properties:
claims:
type: array
items:
title: claim
type: object
properties: {}
required:
- claim-type
anyOf:
- title: mobile-number
type: object
properties:
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- mobile-number
type: string
required:
- mobile-number
- claim-type
- title: individual-identity
type: object
properties:
date-of-birth:
title: date-of-birth
description: ISO 8601 formatted date.
format: date
type: string
given-name:
type: string
surname:
type: string
middle-name:
type: string
claim-type:
enum:
- individual-identity
type: string
required:
- date-of-birth
- given-name
- surname
- claim-type
- title: sole-trader
type: object
properties:
trading-name:
type: string
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- sole-trader
type: string
required:
- trading-name
- trading-address
- claim-type
- title: uk-company-register
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- uk-company-register
type: string
city:
type: string
building-name:
type: string
street-name:
type: string
entity-name:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
building-number:
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
required:
- street-name
- city
- postal-code
- country-code
- entity-name
- entity-registration-number
- corporation-type
- claim-type
- title: individual-income
type: object
properties:
income:
title: income
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- individual-income
type: string
required:
- income
- claim-type
- title: initial-deposit
type: object
properties:
initial-deposit:
title: initial-deposit
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- initial-deposit
type: string
required:
- initial-deposit
- claim-type
- title: international-payments-countries
type: object
properties:
international-payments-countries:
title: international-payments-countries
description: |-
List of country codes for payments received
from UK accounts that are, in full or in part,
funded from international sources. If the
account does not receive payments from
internationally-funded sources, then leave
the collection empty.
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-payments-countries
type: string
required:
- international-payments-countries
- claim-type
- title: company-telephone-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- company-telephone-number
type: string
required:
- telephone-number
- claim-type
- title: person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- person-with-significant-control
type: string
required:
- legal-person-url
- ownership-percent
- claim-type
- title: company-email-address
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- company-email-address
type: string
required:
- email-address
- claim-type
- title: tax-residency
type: object
properties:
tax-residency:
title: tax-residency
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- tax-residency
type: string
required:
- tax-residency
- claim-type
- title: uk-financial-services-register
type: object
properties:
uk-regulatory-permissions:
type: array
items:
title: uk-regulatory-permission
type: string
enum:
- electronic-money-institution
- payment-institution
- client-money
- bank
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
claim-type:
enum:
- uk-financial-services-register
type: string
required:
- uk-regulatory-permissions
- claim-type
- title: business-description
type: object
properties:
business-description:
title: business-description
type: string
minLength: 1
claim-type:
enum:
- business-description
type: string
required:
- business-description
- claim-type
- title: individual-sources-of-funds
type: object
properties:
individual-sources-of-funds:
type: array
items:
title: individual-source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- individual-sources-of-funds
type: string
required:
- individual-sources-of-funds
- claim-type
- title: nominal-person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- nominal-person-with-significant-control
type: string
required:
- legal-person-url
- claim-type
- title: business-address
type: object
properties:
business-address:
title: business-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- business-address
type: string
required:
- business-address
- claim-type
- title: employment
type: object
properties:
claim-type:
enum:
- employment
type: string
required:
- employment-status
- claim-type
anyOf:
- title: self-employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- self-employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: retired
type: object
properties:
employment-status:
enum:
- retired
type: string
required:
- employment-status
- title: unemployed
type: object
properties:
employment-status:
enum:
- unemployed
type: string
required:
- employment-status
- title: employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| |
`alternative-and-complementary-medicine-practitioner`
|
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` |
`civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` |
`lecturer-or-professor` |
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` |
`entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager`
|
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: annual-turnover
type: object
properties:
annual-turnover:
title: annual-turnover
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- annual-turnover
type: string
required:
- annual-turnover
- claim-type
- title: purposes-of-account
type: object
properties:
purposes-of-account:
type: array
items:
title: purpose-of-account
type: string
enum:
- short-term-investment
- long-term-investment
- safeguarding
- staff-payroll
- client-money
- business-expenses
- receiving-payments
- operational-spend
uniqueItems: true
claim-type:
enum:
- purposes-of-account
type: string
required:
- purposes-of-account
- claim-type
- title: sic-codes
type: object
properties:
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
claim-type:
enum:
- sic-codes
type: string
required:
- sic-codes
- claim-type
- title: international-operations-countries
type: object
properties:
international-operations-countries:
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-operations-countries
type: string
required:
- international-operations-countries
- claim-type
- title: sources-of-funds
type: object
properties:
sources-of-funds:
type: array
items:
title: source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- business-income
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- sources-of-funds
type: string
required:
- sources-of-funds
- claim-type
- title: contact-details
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- contact-details
type: string
required:
- email-address
- claim-type
- title: reliance-verification
type: object
properties:
reliance-verification-methods:
type: array
items:
title: reliance-verification-method
type: string
enum:
- manual-document
- physical
- electronic
- manual-biometric
uniqueItems: true
reliance-verification-standard:
title: reliance-verification-standard
type: string
enum:
- jmlsg
claim-type:
enum:
- reliance-verification
type: string
required:
- reliance-verification-methods
- reliance-verification-standard
- claim-type
- title: business-name
type: object
properties:
business-name:
type: string
claim-type:
enum:
- business-name
type: string
required:
- business-name
- claim-type
- title: individual-purposes-of-account
type: object
properties:
individual-purposes-of-account:
type: array
items:
title: individual-purpose-of-account
type: string
enum:
- savings
- bills-and-repayment
- everyday-spending
uniqueItems: true
claim-type:
enum:
- individual-purposes-of-account
type: string
required:
- individual-purposes-of-account
- claim-type
- title: nationality
type: object
properties:
nationality:
title: nationality
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- nationality
type: string
required:
- nationality
- claim-type
- title: trading-name
type: object
properties:
trading-name:
type: string
claim-type:
enum:
- trading-name
type: string
required:
- trading-name
- claim-type
- title: social-media
type: object
properties:
social-media:
title: social-media
type: string
minLength: 1
claim-type:
enum:
- social-media
type: string
required:
- social-media
- claim-type
- title: trading-address
type: object
properties:
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- trading-address
type: string
required:
- trading-address
- claim-type
- title: company-website
type: object
properties:
website-url:
type: string
x-allOf:
- type: string
- {}
claim-type:
enum:
- company-website
type: string
required:
- website-url
- claim-type
- title: director
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
claim-type:
enum:
- director
type: string
required:
- legal-person-url
- claim-type
- title: alternative-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- alternative-number
type: string
required:
- telephone-number
- claim-type
- title: cash-payments
type: object
properties:
cash-payments?:
title: cash-payments?
description: >-
Attestation that funds generated from cash are (true) or
are not (false)
accepted.
type: boolean
claim-type:
enum:
- cash-payments
type: string
required:
- cash-payments?
- claim-type
- title: tax-identification-number
type: object
properties:
tax-identification-number:
title: tax-identification-number
type: string
minLength: 1
claim-type:
enum:
- tax-identification-number
type: string
required:
- tax-identification-number
- claim-type
- title: individual-residence
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- individual-residence
type: string
required:
- street-name
- city
- postal-code
- country-code
- claim-type
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- claims
- links
ClaimsCreateNewClaimResponse:
title: claim
type: object
properties: {}
required:
- claim-type
anyOf:
- title: mobile-number
type: object
properties:
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- mobile-number
type: string
required:
- mobile-number
- claim-type
- title: individual-identity
type: object
properties:
date-of-birth:
title: date-of-birth
description: ISO 8601 formatted date.
format: date
type: string
given-name:
type: string
surname:
type: string
middle-name:
type: string
claim-type:
enum:
- individual-identity
type: string
required:
- date-of-birth
- given-name
- surname
- claim-type
- title: sole-trader
type: object
properties:
trading-name:
type: string
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- sole-trader
type: string
required:
- trading-name
- trading-address
- claim-type
- title: uk-company-register
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- uk-company-register
type: string
city:
type: string
building-name:
type: string
street-name:
type: string
entity-name:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
building-number:
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
required:
- street-name
- city
- postal-code
- country-code
- entity-name
- entity-registration-number
- corporation-type
- claim-type
- title: individual-income
type: object
properties:
income:
title: income
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- individual-income
type: string
required:
- income
- claim-type
- title: initial-deposit
type: object
properties:
initial-deposit:
title: initial-deposit
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- initial-deposit
type: string
required:
- initial-deposit
- claim-type
- title: international-payments-countries
type: object
properties:
international-payments-countries:
title: international-payments-countries
description: |-
List of country codes for payments received
from UK accounts that are, in full or in part,
funded from international sources. If the
account does not receive payments from
internationally-funded sources, then leave
the collection empty.
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-payments-countries
type: string
required:
- international-payments-countries
- claim-type
- title: company-telephone-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- company-telephone-number
type: string
required:
- telephone-number
- claim-type
- title: person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
ownership-percent:
title: ownership-percent
description: >-
The percentage ownership the legal person has of the
corporation.
type: string
format: ''
example: '12.34'
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- person-with-significant-control
type: string
required:
- legal-person-url
- ownership-percent
- claim-type
- title: company-email-address
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
claim-type:
enum:
- company-email-address
type: string
required:
- email-address
- claim-type
- title: tax-residency
type: object
properties:
tax-residency:
title: tax-residency
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- tax-residency
type: string
required:
- tax-residency
- claim-type
- title: uk-financial-services-register
type: object
properties:
uk-regulatory-permissions:
type: array
items:
title: uk-regulatory-permission
type: string
enum:
- electronic-money-institution
- payment-institution
- client-money
- bank
date-of-incorporation:
title: date-of-incorporation
description: ISO 8601 formatted date.
format: date
type: string
entity-name:
type: string
entity-registration-number:
title: entity-registration-number
description: >-
The entity number assigned by the local register. For UK
companies that's the Companies House company number.
type: string
minLength: 1
corporation-type:
title: corporation-type
type: string
enum:
- private-limited-guarant-nsc-limited-exemption
- eeig
- private-limited-shares-section-30-exemption
- limited-partnership
- royal-charter
- private-unlimited-nsc
- old-public-company
- investment-company-with-variable-capital
- other-company-type
- converted-or-closed
- protected-cell-company
- private-limited-guarant-nsc
- scottish-charitable-incorporated-organisation
- industrial-and-provident-society
- registered-society-non-jurisdictional
- private-unlimited
- further-education-or-sixth-form-college-corporation
- limited-liability-partnership
- assurance-company
- other
- northern-ireland-other
- charitable-incorporated-organisation
- oversea-company
- icvc-securities
- uk-establishment
- unregistered-company
- icvc-warrant
- registered-overseas-entity
- public-limited-company
- private-limited-company
- european-public-limited-liability-company-se
- private-unlimted-nsc
- northern-ireland
- icvc-umbrella
- scottish-partnership
claim-type:
enum:
- uk-financial-services-register
type: string
required:
- uk-regulatory-permissions
- claim-type
- title: business-description
type: object
properties:
business-description:
title: business-description
type: string
minLength: 1
claim-type:
enum:
- business-description
type: string
required:
- business-description
- claim-type
- title: individual-sources-of-funds
type: object
properties:
individual-sources-of-funds:
type: array
items:
title: individual-source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- individual-sources-of-funds
type: string
required:
- individual-sources-of-funds
- claim-type
- title: nominal-person-with-significant-control
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
senior-manager?:
type: boolean
claim-type:
enum:
- nominal-person-with-significant-control
type: string
required:
- legal-person-url
- claim-type
- title: business-address
type: object
properties:
business-address:
title: business-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- business-address
type: string
required:
- business-address
- claim-type
- title: employment
type: object
properties:
claim-type:
enum:
- employment
type: string
required:
- employment-status
- claim-type
anyOf:
- title: self-employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| | `alternative-and-complementary-medicine-practitioner` |
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` | `civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` | `lecturer-or-professor`
|
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` | `entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager` |
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- self-employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: retired
type: object
properties:
employment-status:
enum:
- retired
type: string
required:
- employment-status
- title: unemployed
type: object
properties:
employment-status:
enum:
- unemployed
type: string
required:
- employment-status
- title: employed
type: object
properties:
occupation:
title: occupation
description: >
Must be selected according to industry of occupation:
| industry of occupation | occupation |
| ---------------------- | ---------- |
| `marketing-advertising-and-pr` | `marketer` |
| | `fundraising-and-research` |
| | `sales-manager` |
| | `pr` |
| `sales` | `sales` |
| | `customer-service` |
| | `exporter` |
| | `market-researcher` |
| | `importer` |
| | `buyer` |
| `law` | `advocate` |
| | `solicitor` |
| | `judge` |
| | `clerk` |
| | `conveyancer` |
| | `barrister` |
| | `paralegal` |
| `hospitality-and-events-management` | `butcher` |
| | `bar-manager` |
| | `caterer` |
| | `events-manager-or-organiser` |
| | `barista` |
| | `bartender` |
| | `restaurant-worker` |
| | `restaurant-owner` |
| | `chef` |
| | `fishmonger` |
| | `hotel-worker` |
| | `take-away-shop` |
| `personal-care-and-lifestyle` | `nail-technician` |
| | `hairdresser` |
| | `salon-owner` |
| | `nutritionist` |
| | `aesthetician` |
| | `salon-manager` |
| | `sex-worker` |
| `creative-arts-and-design` | `disc-jockey` |
| | `creative-director` |
| | `dancer` |
| | `illustrator` |
| | `graphic-designer` |
| | `interpreter-or-translator` |
| | `jewellery-designer` |
| | `tattoo-artist-or-piercer` |
| | `sound-engineer` |
| | `design-engineer` |
| | `set-and-production-designer` |
| | `fashion-stylist` |
| | `artist` |
| | `costumer` |
| | `musician` |
| | `adult-film-actor` |
| | `product-designer` |
| | `writer` |
| | `editor` |
| | `photographer` |
| | `choreographer` |
| | `copywriter` |
| | `clothing-designer` |
| | `film-director-or-producer-or-editor` |
| | `theatre-manager` |
| | `media-and-broadcasting` |
| | `actor` |
| `information-technology` | `web-designer` |
| | `software-engineer` |
| | `hardware-engineer` |
| | `software-tester` |
| `environment-and-agriculture` | `street-cleaner` |
| | `racehorse-trainer` |
| | `scrap-metal-dealer` |
| | `farmer` |
| | `public-health-inspection` |
| | `environmental-health-officer` |
| | `forest-manager` |
| | `conservation-worker` |
| | `food-inspector` |
| | `florist` |
| | `refuse-disposal` |
| `media-and-internet` | `social-media-influencer` |
| | `printer` |
| | `journalist` |
| | `blogger` |
| | `publisher` |
| | `adult-content-creator` |
| | `editor` |
| `healthcare` | `optician` |
| | `chief-medical-officer` |
| | `doctor-or-surgeon` |
| | `veterinary-nurse` |
| | `massage-therapist` |
| | `health-manager` |
| | `psychiatrist-or-therapist-or-psychologist` |
| | `veterinarian` |
| | `dietician` |
| | `physiotherapist` |
| | `nurse` |
| | `paramedic` |
| | `sports-therapist` |
| | `dentist` |
| | `speech-and-language-therapist` |
| | `alternative-and-complementary-medicine-practitioner` |
| `property-and-construction` | `handyperson` |
| | `construction-worker` |
| | `architect` |
| | `landlord` |
| | `electrician` |
| | `builder` |
| | `carpenter` |
| | `plasterer` |
| | `building-services-manager` |
| | `joiner` |
| | `landscaper-or-groundsperson` |
| | `structural-engineer` |
| | `bricklayer` |
| | `plumber` |
| | `painter` |
| | `facilities-manager` |
| | `property-manager` |
| | `letting-agent` |
| | `construction-manager` |
| | `roofer` |
| | `surveyor` |
| | `estate-agent` |
| | `site-engineer` |
| `public-services-and-administration` | `civil-servant` |
| | `policy-adviser` |
| | `politician` |
| `law-enforcement-and-security` | `customs-officer` |
| | `police-officer` |
| | `probation-office` |
| | `forensic-psychologist` |
| | `firefighter` |
| | `security-guard` |
| | `prison-services-professional` |
| | `crime-analyst` |
| `engineering-and-manufacturing` |
`apparel-and-fashion-professional` |
| | `avionics` |
| | `civil-engineer` |
| | `mechanical-engineer` |
| | `aviation-and-mechanical-technician` |
| | `metal-worker` |
| | `electrical-engineer` |
| | `industrial-engineer` |
| | `metal-and-steel-worker` |
| | `glass-and-glazing-professional` |
| | `precision-instrument-worker` |
| | `manufacturing-operations` |
| | `quality-professional` |
| | `chemical-engineer` |
| `energy-and-utilities` | `boilerman` |
| | `sewage-works-plant-operator` |
| | `quarry-manager` |
| | `water-and-energy-engineer` |
| | `electricity-supplier-plant-operator` |
| | `electricity-supplier-installation-engineer` |
| | `miner` |
| | `drilling-engineer` |
| | `water-treatment-controller` |
| `recruitment-and-hr` | `careers-adviser` |
| | `talent-manager` |
| | `recruiter` |
| | `people-operations` |
| `teacher-training-and-education` | `lecturer-or-professor`
|
| | `teacher` |
| | `dance-teacher` |
| | `librarian` |
| | `teaching-assistant` |
| | `school-inspector` |
| | `curator` |
| | `conservator` |
| | `special-needs-coordinator` |
| | `education-officer` |
| | `archivist` |
| | `educational-establishment-administrator` |
| | `driving-instructor` |
| | `nanny-or-au-pair-or-child-minder` |
| `leisure-sport-and-tourism` | `airport-worker` |
| | `pilot-or-flight-attendant` |
| | `professional-athlete` |
| | `travel-agency-owner` |
| | `personal-trainer` |
| `business-consulting-and-management` | `entrepreneur` |
| | `compliance-manager` |
| | `management-consultant` |
| | `project-manager` |
| | `office-manager` |
| | `product-manager` |
| | `personal-assistant-or-secretary` |
| `charity-and-not-for-profit-organizations` |
`fundraiser-or-development-officer` |
| | `senior-management` |
| |
`advocacy-officer-or-policy-analyst-or-campaign-manager` |
| `transport-and-logistics` | `warehouse-worker` |
| | `taxi-driver` |
| | `transport-manager` |
| | `supply-chain-manager` |
| | `long-haul-trucker` |
| | `warehouse-manager` |
| | `bus-driver` |
| | `delivery-person` |
| `science-and-pharmaceuticals` | `scientist` |
| | `researcher` |
| | `technician` |
| | `chemist` |
| | `pharmacy-manager` |
| | `pharmacist` |
| | `pharmaceutical-manufacturer` |
| `social-care` | `drugs-and-alcohol-counsellor` |
| | `psychiatric-social-worker` |
| | `social-services-manager` |
| | `care-manager` |
| | `day-centre-manager` |
| | `childrens-guardian` |
| | `social-worker` |
| | `youth-worker` |
| | `foster-carer` |
| | `rehabilitation-officer` |
| | `nursing-home-owner` |
| | `welfare-services-counsellor` |
| `accountancy-banking-and-finance` | `stockbroker` |
| | `finance-director` |
| | `stock-trader` |
| | `debt-advisor` |
| | `book-keeper` |
| | `chief-financial-officer` |
| | `tax-advisor` |
| | `investment-advisor` |
| | `accountant` |
| | `mortgage-advisor` |
| | `auditor` |
| | `hedge-fund-manager` |
| | `foreign-exchange-dealer` |
| | `banker` |
| | `financial-advisor` |
| | `relationship-manager` |
| | `insurance-manager` |
| `retail-and-wholesale` | `wholesale-manager` |
| | `shop-owner` |
| | `retail-trade-manager` |
| | `betting-shop-manager` |
| | `newsagent` |
| | `shopkeeper` |
| | `antiques-dealer` |
| | `betting-shop-owner` |
| | `fashion-retailer` |
| | `purchaser` |
| | `car-dealer` |
| `social-and-humanities-scientists` | `geographer` |
| | `epidemiologist` |
| | `archaeologist` |
| | `criminologist` |
| | `social-scientist` |
| | `political-scientist` |
| | `historian` |
| | `anthropologist` |
type: string
example: software-engineer
industry-of-occupation:
title: industry-of-occupation
enum:
- property-and-construction
- recruitment-and-hr
- creative-arts-and-design
- healthcare
- teacher-training-and-education
- engineering-and-manufacturing
- business-consulting-and-management
- leisure-sport-and-tourism
- transport-and-logistics
- charity-and-not-for-profit-organizations
- social-and-humanities-scientists
- science-and-pharmaceuticals
- retail-and-wholesale
- social-care
- accountancy-banking-and-finance
- marketing-advertising-and-pr
- law
- hospitality-and-events-management
- sales
- environment-and-agriculture
- media-and-internet
- personal-care-and-lifestyle
- information-technology
- law-enforcement-and-security
- public-services-and-administration
- energy-and-utilities
type: string
example: information-technology
employment-status:
enum:
- employed
type: string
required:
- occupation
- industry-of-occupation
- employment-status
- title: annual-turnover
type: object
properties:
annual-turnover:
title: annual-turnover
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The unsigned value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
claim-type:
enum:
- annual-turnover
type: string
required:
- annual-turnover
- claim-type
- title: purposes-of-account
type: object
properties:
purposes-of-account:
type: array
items:
title: purpose-of-account
type: string
enum:
- short-term-investment
- long-term-investment
- safeguarding
- staff-payroll
- client-money
- business-expenses
- receiving-payments
- operational-spend
uniqueItems: true
claim-type:
enum:
- purposes-of-account
type: string
required:
- purposes-of-account
- claim-type
- title: sic-codes
type: object
properties:
sic-codes:
type: array
items:
title: sic-code
pattern: ^[0-9]*$
type: string
maxLength: 5
example: '12345'
minLength: 4
claim-type:
enum:
- sic-codes
type: string
required:
- sic-codes
- claim-type
- title: international-operations-countries
type: object
properties:
international-operations-countries:
type: array
items:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- international-operations-countries
type: string
required:
- international-operations-countries
- claim-type
- title: sources-of-funds
type: object
properties:
sources-of-funds:
type: array
items:
title: source-of-funds
type: string
enum:
- gambling-or-lottery
- investments
- property-or-asset-sale
- business-income
- savings
- salary-or-bonus
- student-loans-or-bursary
- retirement-or-pension
- legal-settlement
- family-or-gifted
- loan
- inheritance
uniqueItems: true
claim-type:
enum:
- sources-of-funds
type: string
required:
- sources-of-funds
- claim-type
- title: contact-details
type: object
properties:
email-address:
title: email-address
pattern: .+\@.+\..+
example: user@example.com
mobile-number:
title: mobile-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- contact-details
type: string
required:
- email-address
- claim-type
- title: reliance-verification
type: object
properties:
reliance-verification-methods:
type: array
items:
title: reliance-verification-method
type: string
enum:
- manual-document
- physical
- electronic
- manual-biometric
uniqueItems: true
reliance-verification-standard:
title: reliance-verification-standard
type: string
enum:
- jmlsg
claim-type:
enum:
- reliance-verification
type: string
required:
- reliance-verification-methods
- reliance-verification-standard
- claim-type
- title: business-name
type: object
properties:
business-name:
type: string
claim-type:
enum:
- business-name
type: string
required:
- business-name
- claim-type
- title: individual-purposes-of-account
type: object
properties:
individual-purposes-of-account:
type: array
items:
title: individual-purpose-of-account
type: string
enum:
- savings
- bills-and-repayment
- everyday-spending
uniqueItems: true
claim-type:
enum:
- individual-purposes-of-account
type: string
required:
- individual-purposes-of-account
- claim-type
- title: nationality
type: object
properties:
nationality:
title: nationality
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- nationality
type: string
required:
- nationality
- claim-type
- title: trading-name
type: object
properties:
trading-name:
type: string
claim-type:
enum:
- trading-name
type: string
required:
- trading-name
- claim-type
- title: social-media
type: object
properties:
social-media:
title: social-media
type: string
minLength: 1
claim-type:
enum:
- social-media
type: string
required:
- social-media
- claim-type
- title: trading-address
type: object
properties:
trading-address:
title: trading-address
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- street-name
- city
- postal-code
- country-code
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
claim-type:
enum:
- trading-address
type: string
required:
- trading-address
- claim-type
- title: company-website
type: object
properties:
website-url:
type: string
x-allOf:
- type: string
- {}
claim-type:
enum:
- company-website
type: string
required:
- website-url
- claim-type
- title: director
type: object
properties:
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
companies-house-url:
title: companies-house-url
description: The URL of the entity in Companies House
type: string
example: >-
https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX
claim-type:
enum:
- director
type: string
required:
- legal-person-url
- claim-type
- title: alternative-number
type: object
properties:
telephone-number:
title: telephone-number
pattern: (\+[1-9])?\d{1,14}
example: '+442012345678'
claim-type:
enum:
- alternative-number
type: string
required:
- telephone-number
- claim-type
- title: cash-payments
type: object
properties:
cash-payments?:
title: cash-payments?
description: >-
Attestation that funds generated from cash are (true) or are not
(false)
accepted.
type: boolean
claim-type:
enum:
- cash-payments
type: string
required:
- cash-payments?
- claim-type
- title: tax-identification-number
type: object
properties:
tax-identification-number:
title: tax-identification-number
type: string
minLength: 1
claim-type:
enum:
- tax-identification-number
type: string
required:
- tax-identification-number
- claim-type
- title: individual-residence
type: object
properties:
street-name:
type: string
city:
type: string
postal-code:
title: postal-code
type: string
maxLength: 10
example: NW16XE
minLength: 0
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
claim-type:
enum:
- individual-residence
type: string
required:
- street-name
- city
- postal-code
- country-code
- claim-type
anyOf:
- title: both building-name and building-number
type: object
properties:
building-name:
type: string
building-number:
type: string
required:
- building-name
- building-number
- title: only building-name
type: object
properties:
building-name:
type: string
required:
- building-name
- title: only building-number
type: object
properties:
building-number:
type: string
required:
- building-number
DecisionsListForLegalPersonResponse:
title: decisions-response
type: object
properties:
decisions:
type: array
items:
title: decision
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: Indicates if the decision was automated or made by a human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: Free-text field to explain the reasons behind the decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- decisions
- links
DecisionsCreateDecisionResponse:
title: decision
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: Indicates if the decision was automated or made by a human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: Free-text field to explain the reasons behind the decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the decision
(if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
LegalPersonHistoryListEventsResponse:
title: legal-person-history-response
type: object
properties:
legal-person-history:
type: array
items:
title: history event
type: object
properties: {}
required:
- legal-person-history-event-type
anyOf:
- title: risk-rating-registered
type: object
properties:
legal-person-history-event-type:
enum:
- risk-rating-registered
type: string
timestamp:
title: timestamp
description: Date time of this event.
format: date-time
type: string
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
notes:
title: notes
description: Rationale for overriding the risk rating.
type: string
minLength: 1
manually-created-by:
title: manually-created-by
description: User that triggered this event.
type: object
properties: {}
required:
- manually-created-by-type
anyOf:
- title: ops-user
type: object
properties:
manually-created-by-type:
enum:
- ops-user
type: string
required:
- manually-created-by-type
- manually-created-by-type
previous-risk-rating:
title: previous-risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
required:
- legal-person-history-event-type
- timestamp
- risk-rating
- legal-person-history-event-type
- title: decision-created
type: object
properties:
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-notes:
title: decision-notes
description: >-
Free-text field to explain the reasons behind the
decision.
type: string
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
legal-person-history-event-type:
title: legal-person-history-event-type
type: string
enum:
- risk-rating-registered
- decision-created
timestamp:
title: timestamp
description: Date time of this event.
format: date-time
type: string
decision-maker:
title: decision-maker
description: >-
Indicates if the decision was automated or made by a
human.
enum:
- system
- ops-user
- user
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made
the decision (if applicable).
type: string
example: user@example.com
required:
- legal-person-history-event-type
- timestamp
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- legal-person-history-event-type
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- legal-person-history
- links
VerificationsListForLegalPersonResponse:
title: verifications-response
type: object
properties:
verifications:
type: array
items:
title: verification
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
verification-checks-url:
title: verification-checks-url
type: string
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
verification-status:
title: verification-status
type: string
enum:
- in-progress
- pending
- checks-declined
- checks-complete
- failed
verification-risk-assessments-url:
title: verification-risk-assessments-url
type: string
required:
- created-at
- legal-person-url
- verification-status
- verification-url
- verification-checks-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- verifications
- links
VerificationsInitiateVerificationResponse:
title: verification
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
verification-checks-url:
title: verification-checks-url
type: string
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
verification-status:
title: verification-status
type: string
enum:
- in-progress
- pending
- checks-declined
- checks-complete
- failed
verification-risk-assessments-url:
title: verification-risk-assessments-url
type: string
required:
- created-at
- legal-person-url
- verification-status
- verification-url
- verification-checks-url
MembershipsGetMembershipInfoResponse:
title: membership
type: object
properties:
membership-url:
title: membership-url
description: Link to the [membership](http://docs.griffin.com).
type: string
example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA
membership-roles-url:
title: membership-roles-url
description: >-
Link to the assigned [roles](http://docs.griffin.com) for this
[membership](http://docs.griffin.com).
type: string
example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles
organization:
title: organization
description: Shows the associated [organization](http://docs.griffin.com).
type: object
properties:
own-legal-person-url:
title: own-legal-person-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [organization](http://docs.griffin.com); this can
be an individual or a company.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
organization-mode:
title: organization-mode
description: >-
The organization can either be a sandbox organization or a live
one; Check out our guide for [sandbox mode vs live
mode](http://docs.griffin.com).
enum:
- test-mode
- live-mode
type: string
organization-memberships-url:
title: organization-memberships-url
description: >-
Link to the [memberships](http://docs.griffin.com) for this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships
organization-invitations-url:
title: organization-invitations-url
description: >-
Link to the resource that enables you to
[invite](http://docs.griffin.com) new
[users](http://docs.griffin.com) to this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations
organization-onboarding-applications-url:
title: organization-onboarding-applications-url
description: Link to the [Reliance onboarding](http://docs.griffin.com).
type: string
example: >-
/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
organization-api-keys-url:
title: organization-api-keys-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys
organization-live-access-url:
title: organization-live-access-url
description: Link to the resource that enables you to request live access.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access
organization-webhooks-url:
title: organization-webhooks-url
description: Link to the endpoint which enables webhook creation.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks
organization-workflows-url:
title: organization-workflows-url
description: >-
Link to the onboarding [workflows](http://docs.griffin.com)
configured for this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows
organization-bank-accounts-url:
title: organization-bank-accounts-url
description: >-
Link to the [bank accounts](http://docs.griffin.com) managed by
this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts
available-roles:
title: available-roles
description: >-
The subset of [roles](http://docs.griffin.com) available to
[members](http://docs.griffin.com) of this
[organization](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
can-decide-on-verifications?:
title: can-decide-on-verifications?
description: >-
Is this organization able to make manual decisions on
verifications?
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
organization-individuals-url:
title: organization-individuals-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals
organization-corporations-url:
title: organization-corporations-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations
organization-legal-persons-url:
title: organization-legal-persons-url
description: >-
Link to the [legal persons](http://docs.griffin.com) grouped
under this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons
organization-events-url:
title: organization-events-url
description: Link to the endpoint which lists an organization's events.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events
required:
- available-roles
- can-decide-on-verifications?
- display-name
- organization-api-keys-url
- organization-bank-accounts-url
- organization-corporations-url
- organization-events-url
- organization-individuals-url
- organization-invitations-url
- organization-legal-persons-url
- organization-live-access-url
- organization-memberships-url
- organization-mode
- organization-url
- organization-webhooks-url
- organization-workflows-url
- own-legal-person-url
roles:
title: roles
description: Shows a collection of [roles](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
user:
title: user
description: Shows the associated [user](http://docs.griffin.com).
type: object
properties:
user-email:
title: user-email
description: The user's email address.
type: string
example: user@example.com
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
user-username:
title: user-username
description: The username.
type: string
example: user@example.com
api-keys-url:
title: api-keys-url
description: Link to the user's [api keys](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys
user-memberships-url:
title: user-memberships-url
description: Link to the user's [memberships](http://docs.griffin.com).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships
given-name:
type: string
surname:
type: string
required:
- user-email
- user-url
- user-username
- api-keys-url
- user-memberships-url
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- membership-url
- membership-roles-url
- organization
- roles
- user
- created-at
RolesGetMembershipRolesResponse:
title: roles-response
type: object
properties:
roles:
title: roles
description: Shows a collection of [roles](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
required:
- roles
RolesAssignMembershipRolesResponse:
title: roles-response
type: object
properties:
roles:
title: roles
description: Shows a collection of [roles](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
required:
- roles
RelianceOnboardingGetApplicationResponse:
title: onboarding-application
type: object
properties: {}
required:
- onboarding-application-status
anyOf:
- title: processing
type: object
properties:
onboarding-application-url:
title: onboarding-application-url
description: Link to the onboarding application.
type: string
example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
onboarding-application-status:
enum:
- processing
type: string
required:
- created-at
- legal-person-url
- onboarding-application-url
- verification-url
- workflow-url
- onboarding-application-status
- title: submitted
type: object
properties:
onboarding-application-url:
title: onboarding-application-url
description: Link to the onboarding application.
type: string
example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
onboarding-application-status:
enum:
- submitted
type: string
required:
- created-at
- onboarding-application-url
- workflow-url
- onboarding-application-status
- title: errored
type: object
properties:
onboarding-application-url:
title: onboarding-application-url
description: Link to the onboarding application.
type: string
example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
onboarding-application-status:
enum:
- errored
type: string
required:
- created-at
- legal-person-url
- onboarding-application-url
- verification-url
- workflow-url
- onboarding-application-status
- title: complete
type: object
properties:
onboarding-application-url:
title: onboarding-application-url
description: Link to the onboarding application.
type: string
example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
onboarding-application-status:
enum:
- complete
type: string
required:
- created-at
- decision-outcome
- legal-person-url
- onboarding-application-url
- verification-url
- workflow-url
- onboarding-application-status
OrganizationsGetDetailsResponse:
title: organization
type: object
properties:
own-legal-person-url:
title: own-legal-person-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [organization](http://docs.griffin.com); this can be an
individual or a company.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
organization-mode:
title: organization-mode
description: >-
The organization can either be a sandbox organization or a live one;
Check out our guide for [sandbox mode vs live
mode](http://docs.griffin.com).
enum:
- test-mode
- live-mode
type: string
organization-memberships-url:
title: organization-memberships-url
description: >-
Link to the [memberships](http://docs.griffin.com) for this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships
organization-invitations-url:
title: organization-invitations-url
description: >-
Link to the resource that enables you to
[invite](http://docs.griffin.com) new
[users](http://docs.griffin.com) to this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations
organization-onboarding-applications-url:
title: organization-onboarding-applications-url
description: Link to the [Reliance onboarding](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
organization-api-keys-url:
title: organization-api-keys-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys
organization-live-access-url:
title: organization-live-access-url
description: Link to the resource that enables you to request live access.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access
organization-webhooks-url:
title: organization-webhooks-url
description: Link to the endpoint which enables webhook creation.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks
organization-workflows-url:
title: organization-workflows-url
description: >-
Link to the onboarding [workflows](http://docs.griffin.com)
configured for this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows
organization-bank-accounts-url:
title: organization-bank-accounts-url
description: >-
Link to the [bank accounts](http://docs.griffin.com) managed by this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts
available-roles:
title: available-roles
description: >-
The subset of [roles](http://docs.griffin.com) available to
[members](http://docs.griffin.com) of this
[organization](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
organization-individuals-url:
title: organization-individuals-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals
organization-corporations-url:
title: organization-corporations-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations
organization-legal-persons-url:
title: organization-legal-persons-url
description: >-
Link to the [legal persons](http://docs.griffin.com) grouped under
this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons
organization-events-url:
title: organization-events-url
description: Link to the endpoint which lists an organization's events.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events
required:
- available-roles
- can-decide-on-verifications?
- display-name
- organization-api-keys-url
- organization-bank-accounts-url
- organization-corporations-url
- organization-events-url
- organization-individuals-url
- organization-invitations-url
- organization-legal-persons-url
- organization-live-access-url
- organization-memberships-url
- organization-mode
- organization-url
- organization-webhooks-url
- organization-workflows-url
- own-legal-person-url
ApiKeysListActiveKeysResponse:
title: api-keys-response
type: object
properties:
api-keys:
type: array
items:
title: api-key
type: object
properties:
api-key-url:
title: api-key-url
description: The resource path for the API key
type: string
example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
api-key-name:
title: api-key-name
description: The immutable display name for the API key
pattern: ^[a-zA-z0-9-_]+
maxLength: 64
example: buildserver
minLength: 1
api-key-live?:
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- api-key-url
- api-key-name
- api-key-live?
- organization-url
- user-url
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- api-keys
- links
ApiKeysCreateKeyResponse:
type: object
properties:
api-key-url:
title: api-key-url
description: The resource path for the API key
type: string
example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
api-key-name:
title: api-key-name
description: The immutable display name for the API key
pattern: ^[a-zA-z0-9-_]+
maxLength: 64
example: buildserver
minLength: 1
api-key-live?:
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
api-key-secret:
title: api-key-secret
description: The API secret
type: string
example: g-test-buildserver-RrUZ5fUG4pSKwYVVG1C3Ft1xrMRxy1T7KUIyTva5bTk
required:
- api-key-live?
- api-key-name
- api-key-secret
- api-key-url
- created-at
- organization-url
- user-url
BankAccountsListResponse:
title: ''
type: object
properties:
accounts:
type: array
items:
title: bank-account
type: object
properties:
account-submissions-url:
title: account-submissions-url
description: >-
Link to the [payment submissions](http://docs.griffin.com)
debiting from this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions
account-restricted:
title: account-restricted
description: >-
Specifies whether the bank account has restrictions applied by
Griffin.
type: boolean
account-payments-url:
title: account-payments-url
description: >-
Link to the [payments](http://docs.griffin.com) associated
with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments
pooled-account-memberships-url:
title: pooled-account-memberships-url
description: >-
Link to the list of [pool members](http://docs.griffin.com)
associated with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership
account-admissions-url:
title: account-admissions-url
description: >-
Link to the [payment admissions](http://docs.griffin.com)
crediting to this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions
bank-product-type:
title: bank-product-type
description: >-
Specifies the type of bank account. (For more detail on bank
account types, see our guide for [creating a bank
account](http://docs.griffin.com).)
enum:
- savings-account
- client-money-account
- safeguarding-account
- operational-account
type: string
display-name:
title: display-name
description: The mutable display name for the bank account
type: string
minLength: 1
maxLength: 64
example: Reserve a/c
controller-url:
title: controller-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [controller](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
title: pooled-funds
description: >-
Specifies whether the bank account holds funds belonging to
multiple beneficiaries.
type: boolean
account-status:
title: account-status
description: >-
Shows the status of the account. An account can be moved
between statuses during its lifecycle. The status value
affects the operations that you can perform. An account must
be `"open"` to be fully operational.
enum:
- closing
- open
- closed
- opening
type: string
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [owner](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
close-account-url:
title: close-account-url
description: >-
Link to the endpoint that enables account closure for this
account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close
available-balance:
title: available-balance
description: Shows the [available balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
pooled-account-membership-updates-url:
title: pooled-account-membership-updates-url
description: >-
Link to manage [pooled account
membership](http://docs.griffin.com).
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates
bank-addresses:
title: bank-addresses
description: >-
Shows a collection of public addresses which uniquely identify
the account. Any one of these can be used to pay into the
account.
type: array
items:
title: bank-address
type: object
properties:
account-holder:
title: account-holder
description: >-
The name of the [account
holder](http://docs.griffin.com).
type: string
minLength: 1
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
required:
- account-holder
- bank-id-code
- bank-id
- account-number
- account-number-code
account-transactions-url:
title: account-transactions-url
description: >-
Link to the [transactions](http://docs.griffin.com) associated
with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [beneficiary](http://docs.griffin.com) of the
account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
savings-type:
title: savings-type
description: Specifies the type of savings account.
enum:
- easy-access
type: string
required:
- account-balance
- available-balance
- account-payments-url
- account-admissions-url
- account-submissions-url
- account-transactions-url
- account-url
- close-account-url
- owner-url
- controller-url
- display-name
- account-restricted
- account-status
- bank-product-type
- pooled-funds
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
included:
title: ''
description: Present only when the request uses the `include` parameter.
type: object
properties:
legal-persons:
type: array
items:
title: legal-person
type: object
properties:
latest-decision:
title: latest-decision
description: The most recent [decision](http://docs.griffin.com)
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: >-
Indicates if the decision was automated or made by a
human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: >-
Free-text field to explain the reasons behind the
decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made
the decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that
made the decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
legal-person-type:
title: legal-person-type
description: >-
Specifies if the legal person is an `individual` or a
`corporation`.
enum:
- individual
- corporation
type: string
latest-risk-rating-url:
title: latest-risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
display-name:
title: display-name
description: The mutable display name for the bank account
type: string
minLength: 1
maxLength: 64
example: Reserve a/c
application-status:
title: application-status
description: >-
Status of the current
[application](http://docs.griffin.com)
enum:
- referred
- errored
- declined
- submitted
- accepted
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
legal-person-decisions-url:
title: legal-person-decisions-url
description: >-
Link to [decisions](http://docs.griffin.com) for this
[legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions
status-changed-at:
title: status-changed-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-claims-url:
title: legal-person-claims-url
description: >-
Link to the [claims](http://docs.griffin.com) for this
[legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims
legal-person-bank-payees-url:
title: legal-person-bank-payees-url
description: >-
Link to the [payees](http://docs.griffin.com) for this
[legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees
legal-person-verifications-url:
title: legal-person-verifications-url
description: >-
Link to all [verifications](http://docs.griffin.com) run
against this [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications
legal-person-documents-url:
title: legal-person-documents-url
description: >-
Link to all evidence documents associated with this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents
required:
- created-at
- display-name
- legal-person-decisions-url
- legal-person-documents-url
- legal-person-type
- legal-person-url
- legal-person-verifications-url
required:
- legal-persons
required:
- accounts
- links
BankAccountsCreateNewAccountResponse:
title: bank-account
type: object
properties:
account-submissions-url:
title: account-submissions-url
description: >-
Link to the [payment submissions](http://docs.griffin.com) debiting
from this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions
account-restricted:
title: account-restricted
description: >-
Specifies whether the bank account has restrictions applied by
Griffin.
type: boolean
account-payments-url:
title: account-payments-url
description: >-
Link to the [payments](http://docs.griffin.com) associated with this
account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments
pooled-account-memberships-url:
title: pooled-account-memberships-url
description: >-
Link to the list of [pool members](http://docs.griffin.com)
associated with this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership
account-admissions-url:
title: account-admissions-url
description: >-
Link to the [payment admissions](http://docs.griffin.com) crediting
to this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions
bank-product-type:
title: bank-product-type
description: >-
Specifies the type of bank account. (For more detail on bank account
types, see our guide for [creating a bank
account](http://docs.griffin.com).)
enum:
- savings-account
- client-money-account
- safeguarding-account
- operational-account
type: string
display-name:
title: display-name
description: The mutable display name for the bank account
type: string
minLength: 1
maxLength: 64
example: Reserve a/c
controller-url:
title: controller-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [controller](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
pooled-funds:
title: pooled-funds
description: >-
Specifies whether the bank account holds funds belonging to multiple
beneficiaries.
type: boolean
account-status:
title: account-status
description: >-
Shows the status of the account. An account can be moved between
statuses during its lifecycle. The status value affects the
operations that you can perform. An account must be `"open"` to be
fully operational.
enum:
- closing
- open
- closed
- opening
type: string
client-money-type:
title: client-money-type
description: Specifies the type of client money account.
enum:
- designated-client-fund
- designated-client-money
- general-client-money
type: string
owner-url:
title: owner-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [owner](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
close-account-url:
title: close-account-url
description: Link to the endpoint that enables account closure for this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close
available-balance:
title: available-balance
description: Shows the [available balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
pooled-account-membership-updates-url:
title: pooled-account-membership-updates-url
description: Link to manage [pooled account membership](http://docs.griffin.com).
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates
bank-addresses:
title: bank-addresses
description: >-
Shows a collection of public addresses which uniquely identify the
account. Any one of these can be used to pay into the account.
type: array
items:
title: bank-address
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
required:
- account-holder
- bank-id-code
- bank-id
- account-number
- account-number-code
account-transactions-url:
title: account-transactions-url
description: >-
Link to the [transactions](http://docs.griffin.com) associated with
this account.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
beneficiary-url:
title: beneficiary-url
description: >-
Link to the [legal person](http://docs.griffin.com) that represents
the [beneficiary](http://docs.griffin.com) of the account.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
account-balance:
title: account-balance
description: Shows the [account balance](http://docs.griffin.com).
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
savings-type:
title: savings-type
description: Specifies the type of savings account.
enum:
- easy-access
type: string
required:
- account-balance
- available-balance
- account-payments-url
- account-admissions-url
- account-submissions-url
- account-transactions-url
- account-url
- close-account-url
- owner-url
- controller-url
- display-name
- account-restricted
- account-status
- bank-product-type
- pooled-funds
- created-at
EventsGetAllOrganizationEventsResponse:
title: organization-events-response
type: object
properties:
events:
type: array
items:
title: event
type: object
properties:
event-url:
title: event-url
description: Link to the [event](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/events/ev.ICAgICAgICBldmVudC1pZA
event-type:
title: event-type
description: >-
The type of webhook event. Usually has the form
{resource}-{operation}, e.g. payment-updated
enum:
- decision-created
- payment-created
- transaction-created
- verification-updated
- admission-updated
- verification-created
- account-status-updated
- submission-created
- test-event
- admission-created
- account-status-created
- submission-updated
type: string
event-payload:
type: object
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- event-url
- event-type
- event-payload
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- events
- links
LegalPersonsListLegalPersonsResponse:
title: ''
type: object
properties:
legal-persons:
type: array
items:
title: legal-person
type: object
properties:
latest-decision:
title: latest-decision
description: The most recent [decision](http://docs.griffin.com)
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: >-
Indicates if the decision was automated or made by a
human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: >-
Free-text field to explain the reasons behind the
decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made
the decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
legal-person-type:
title: legal-person-type
description: >-
Specifies if the legal person is an `individual` or a
`corporation`.
enum:
- individual
- corporation
type: string
latest-risk-rating-url:
title: latest-risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
display-name:
title: display-name
description: The mutable display name for the Legal-Person
type: string
minLength: 1
maxLength: 64
example: Company name
application-status:
title: application-status
description: Status of the current [application](http://docs.griffin.com)
enum:
- referred
- errored
- declined
- submitted
- accepted
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
legal-person-decisions-url:
title: legal-person-decisions-url
description: >-
Link to [decisions](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions
status-changed-at:
title: status-changed-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-claims-url:
title: legal-person-claims-url
description: >-
Link to the [claims](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims
legal-person-bank-payees-url:
title: legal-person-bank-payees-url
description: >-
Link to the [payees](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees
legal-person-verifications-url:
title: legal-person-verifications-url
description: >-
Link to all [verifications](http://docs.griffin.com) run
against this [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications
legal-person-documents-url:
title: legal-person-documents-url
description: >-
Link to all evidence documents associated with this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents
required:
- created-at
- display-name
- legal-person-decisions-url
- legal-person-documents-url
- legal-person-type
- legal-person-url
- legal-person-verifications-url
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
meta:
title: meta
type: object
properties:
page:
title: page
type: object
properties:
total:
title: total
description: >-
Total number of items. Present when the total number of
items in the full result set is less than 10,000.
type: integer
format: int64
minimum: 0
estimated-total:
title: estimated-total
type: object
properties:
at-least:
title: at-least
description: >-
Present when the total number of items in the full
result set exceeds 10,000. This indicates that the
actual number of items is at least 10,000, but the exact
total is not provided due to performance considerations.
enum:
- 10000
type: integer
included:
title: ''
description: Present only when the request uses the `include` parameter.
type: object
properties:
verifications:
type: array
items:
title: verification
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
verification-checks-url:
title: verification-checks-url
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/checks
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
verification-status:
title: verification-status
type: string
enum:
- in-progress
- pending
- checks-declined
- checks-complete
- failed
verification-risk-assessments-url:
title: verification-risk-assessments-url
type: string
example: >-
/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/risk-assessments
required:
- created-at
- legal-person-url
- verification-status
- verification-url
- verification-checks-url
risk-rating-entries:
type: array
items:
title: risk-rating-entry
type: object
properties:
risk-rating-url:
title: risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
legal-person-url:
title: legal-person-url
description: >-
A contextual link to the [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
notes:
title: notes
description: Rationale for overriding the risk rating.
type: string
minLength: 1
manually-created-by:
title: manually-created-by
description: User that triggered this event.
type: object
properties: {}
required:
- manually-created-by-type
anyOf:
- title: ops-user
type: object
properties:
manually-created-by-type:
enum:
- ops-user
type: string
required:
- manually-created-by-type
- manually-created-by-type
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
previous-risk-rating:
title: previous-risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
required:
- risk-rating-url
- risk-rating
- legal-person-url
required:
- legal-persons
- links
LegalPersonsCreateNewLegalPersonResponse:
title: legal-person
type: object
properties:
latest-decision:
title: latest-decision
description: The most recent [decision](http://docs.griffin.com)
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
decision-outcome:
title: decision-outcome
type: string
enum:
- accepted
- declined
decision-maker:
title: decision-maker
description: Indicates if the decision was automated or made by a human.
enum:
- system
- ops-user
- user
type: string
decision-notes:
title: decision-notes
description: Free-text field to explain the reasons behind the decision.
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
decision-user-url:
title: decision-user-url
description: >-
Link to the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
decision-user-username:
title: decision-user-username
description: >-
Username of the [user](http://docs.griffin.com) that made the
decision (if applicable).
type: string
example: user@example.com
decision-ops-user:
title: decision-ops-user
description: Indicates that an Ops user has created the decision.
enum:
- griffin-ops-user
type: string
required:
- verification-url
- decision-outcome
- decision-maker
- decision-notes
- created-at
legal-person-type:
title: legal-person-type
description: Specifies if the legal person is an `individual` or a `corporation`.
enum:
- individual
- corporation
type: string
latest-risk-rating-url:
title: latest-risk-rating-url
description: A contextual link to the risk rating.
type: string
example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA
display-name:
title: display-name
description: The mutable display name for the Legal-Person
type: string
minLength: 1
maxLength: 64
example: Company name
application-status:
title: application-status
description: Status of the current [application](http://docs.griffin.com)
enum:
- referred
- errored
- declined
- submitted
- accepted
type: string
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
legal-person-decisions-url:
title: legal-person-decisions-url
description: >-
Link to [decisions](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions
status-changed-at:
title: status-changed-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-claims-url:
title: legal-person-claims-url
description: >-
Link to the [claims](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims
legal-person-bank-payees-url:
title: legal-person-bank-payees-url
description: >-
Link to the [payees](http://docs.griffin.com) for this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees
legal-person-verifications-url:
title: legal-person-verifications-url
description: >-
Link to all [verifications](http://docs.griffin.com) run against
this [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications
legal-person-documents-url:
title: legal-person-documents-url
description: >-
Link to all evidence documents associated with this [legal
person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents
required:
- created-at
- display-name
- legal-person-decisions-url
- legal-person-documents-url
- legal-person-type
- legal-person-url
- legal-person-verifications-url
MembershipsListOrganizationMembershipsResponse:
title: memberships-response
type: object
properties:
memberships:
type: array
items:
title: membership
type: object
properties:
membership-url:
title: membership-url
description: Link to the [membership](http://docs.griffin.com).
type: string
example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA
membership-roles-url:
title: membership-roles-url
description: >-
Link to the assigned [roles](http://docs.griffin.com) for this
[membership](http://docs.griffin.com).
type: string
example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles
organization:
title: organization
type: object
properties:
own-legal-person-url:
title: own-legal-person-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [organization](http://docs.griffin.com);
this can be an individual or a company.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
organization-mode:
title: organization-mode
description: >-
The organization can either be a sandbox organization or a
live one; Check out our guide for [sandbox mode vs live
mode](http://docs.griffin.com).
enum:
- test-mode
- live-mode
type: string
organization-memberships-url:
title: organization-memberships-url
description: >-
Link to the [memberships](http://docs.griffin.com) for
this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships
organization-invitations-url:
title: organization-invitations-url
description: >-
Link to the resource that enables you to
[invite](http://docs.griffin.com) new
[users](http://docs.griffin.com) to this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations
organization-onboarding-applications-url:
title: organization-onboarding-applications-url
description: >-
Link to the [Reliance
onboarding](http://docs.griffin.com).
type: string
example: >-
/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
organization-api-keys-url:
title: organization-api-keys-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys
organization-live-access-url:
title: organization-live-access-url
description: >-
Link to the resource that enables you to request live
access.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access
organization-webhooks-url:
title: organization-webhooks-url
description: Link to the endpoint which enables webhook creation.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks
organization-workflows-url:
title: organization-workflows-url
description: >-
Link to the onboarding
[workflows](http://docs.griffin.com) configured for this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows
organization-bank-accounts-url:
title: organization-bank-accounts-url
description: >-
Link to the [bank accounts](http://docs.griffin.com)
managed by this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts
available-roles:
title: available-roles
description: >-
The subset of [roles](http://docs.griffin.com) available
to [members](http://docs.griffin.com) of this
[organization](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
can-decide-on-verifications?:
title: can-decide-on-verifications?
description: >-
Is this organization able to make manual decisions on
verifications?
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
organization-individuals-url:
title: organization-individuals-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals
organization-corporations-url:
title: organization-corporations-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations
organization-legal-persons-url:
title: organization-legal-persons-url
description: >-
Link to the [legal persons](http://docs.griffin.com)
grouped under this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons
organization-events-url:
title: organization-events-url
description: Link to the endpoint which lists an organization's events.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events
required:
- available-roles
- can-decide-on-verifications?
- display-name
- organization-api-keys-url
- organization-bank-accounts-url
- organization-corporations-url
- organization-events-url
- organization-individuals-url
- organization-invitations-url
- organization-legal-persons-url
- organization-live-access-url
- organization-memberships-url
- organization-mode
- organization-url
- organization-webhooks-url
- organization-workflows-url
- own-legal-person-url
roles:
title: roles
description: Shows a collection of [roles](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
user:
title: user
description: Shows the associated [user](http://docs.griffin.com).
type: object
properties:
user-email:
title: user-email
description: The user's email address.
type: string
example: user@example.com
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
user-username:
title: user-username
description: The username.
type: string
example: user@example.com
api-keys-url:
title: api-keys-url
description: Link to the user's [api keys](http://docs.griffin.com).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys
user-memberships-url:
title: user-memberships-url
description: Link to the user's [memberships](http://docs.griffin.com).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships
given-name:
type: string
surname:
type: string
required:
- user-email
- user-url
- user-username
- api-keys-url
- user-memberships-url
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- membership-url
- membership-roles-url
- organization
- roles
- user
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- memberships
- links
RelianceOnboardingCreateApplicationResponse:
title: onboarding-application-created-response
type: object
properties:
onboarding-application-url:
title: onboarding-application-url
description: Link to the onboarding application.
type: string
example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ
onboarding-application-status:
title: onboarding-application-status
type: string
enum:
- processing
- submitted
- errored
- complete
required:
- onboarding-application-url
- onboarding-application-status
WebhooksGetAllResponse:
title: organization-webhooks-response
type: object
properties:
organization-webhooks:
type: array
items:
title: webhook
type: object
properties:
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
webhook-url:
title: webhook-url
description: Link to the [webhook](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
test-webhook-url:
title: test-webhook-url
description: Test a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test
activate-webhook-url:
title: activate-webhook-url
description: Activate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate
deactivate-webhook-url:
title: deactivate-webhook-url
description: Deactivate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- organization-url
- webhook-url
- webhook-destination-url
- test-webhook-url
- activate-webhook-url
- deactivate-webhook-url
required:
- organization-webhooks
WebhooksCreateWebhookResponse:
title: webhook
type: object
properties:
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
webhook-url:
title: webhook-url
description: Link to the [webhook](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
test-webhook-url:
title: test-webhook-url
description: Test a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test
activate-webhook-url:
title: activate-webhook-url
description: Activate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate
deactivate-webhook-url:
title: deactivate-webhook-url
description: Deactivate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- organization-url
- webhook-url
- webhook-destination-url
- test-webhook-url
- activate-webhook-url
- deactivate-webhook-url
WorkflowsListOrganizationWorkflowsResponse:
title: organization-workflows-response
type: object
properties:
workflows:
type: array
items:
title: workflow
type: object
properties:
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
legal-person-type:
title: legal-person-type
description: >-
Specifies if the legal person is an `individual` or a
`corporation`.
enum:
- individual
- corporation
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required-claim-types:
title: required-claim-types
description: |-
A mapping of workflow-appropriate legal person types
to claims that are required for each type.
type: object
additionalProperties:
type: array
items:
title: claim-type
type: string
enum:
- mobile-number
- individual-identity
- sole-trader
- uk-company-register
- individual-income
- business-website
- initial-deposit
- international-payments-countries
- company-telephone-number
- managed-properties
- person-with-significant-control
- business-industry
- tenant-cash-payments
- verified-bank-account
- company-email-address
- tax-residency
- uk-financial-services-register
- non-tenant-balance
- business-description
- hmrc-register
- vat-registration
- business-email-address
- client-money-protection-scheme
- individual-sources-of-funds
- nominal-person-with-significant-control
- hmo-verification
- business-address
- employment
- annual-turnover
- purposes-of-account
- sic-codes
- international-operations-countries
- sources-of-funds
- business-owner
- business-telephone-number
- individual-email-address
- business-start-date
- contact-details
- reliance-verification
- ultimate-beneficial-owner
- business-name
- individual-purposes-of-account
- nationality
- trading-name
- number-of-employees
- social-media
- trading-address
- company-website
- director
- alternative-number
- cash-payments
- tax-identification-number
- individual-residence
uniqueItems: true
workflow-rules:
title: workflow-rules
description: A list of special behaviours a workflow can possess.
type: array
items:
type: string
enum:
- allow-zero-directors
- allow-missing-directors
uniqueItems: true
required:
- workflow-url
- display-name
- legal-person-type
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- workflows
- links
PayeesGetDetailsResponse:
title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
payee-status:
title: payee-status
description: >-
The status of the payee; you can only make payments to active
payees.
enum:
- deactivated
- active
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- account-holder
- account-number
- bank-id
- country-code
- created-at
- legal-person-url
- payee-status
- payee-url
PayeesUpdatePayeeResponse:
title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
payee-status:
title: payee-status
description: >-
The status of the payee; you can only make payments to active
payees.
enum:
- deactivated
- active
type: string
country-code:
title: country-code
description: ISO 3166-1 alpha-2 two-letter country code.
maxLength: 2
example: GB
minLength: 2
required:
- account-holder
- account-number
- bank-id
- country-code
- created-at
- legal-person-url
- payee-status
- payee-url
PaymentsGetDetailsResponse:
title: payment
type: object
properties:
creditor:
title: creditor
type: object
properties: {}
required:
- creditor-type
anyOf:
- title: payee
type: object
properties:
payee-url:
title: payee-url
description: Link to the [payee](http://docs.griffin.com).
type: string
example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA
creditor-type:
enum:
- payee
type: string
required:
- payee-url
- creditor-type
- title: griffin-bank-account
type: object
properties:
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
creditor-type:
enum:
- griffin-bank-account
type: string
required:
- account-url
- creditor-type
- title: uk-domestic
type: object
properties:
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
creditor-type:
enum:
- uk-domestic
type: string
required:
- account-holder
- account-number
- account-number-code
- bank-id
- bank-id-code
- creditor-type
payment-direction:
title: payment-direction
description: Whether the payment is moving money into or out of the account.
enum:
- inbound-payment
- outbound-payment
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
payment-reference:
title: payment-reference
description: Free-text field to help identify and categorise payments.
type: string
maxLength: 35
example: test reference
minLength: 1
payment-amount:
title: payment-amount
description: >-
Compound value representing both the currency and amount of money
being sent.
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
x-allOf:
- title: money-amount
required:
- currency
- value
properties:
currency:
title: currency code
enum:
- GBP
type: string
example: GBP
default: GBP
value:
title: value
description: The value as a decimal-formatted string
type: string
example: '1000.00'
default: '1.00'
type: object
- x-allOf:
- x-allOf:
- {}
- {}
- {}
ultimate-debtor:
title: ultimate-debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
payment-admissions-url:
title: payment-admissions-url
description: Link to the endpoint for listing payment admissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions
payment-submissions-url:
title: payment-submissions-url
description: Link to the endpoint for creating and listing payment submissions.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions
debtor:
title: debtor
type: object
properties:
account-number:
title: account-number
description: Must be a UK BBAN.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{8}$
maxLength: 8
example: '12345678'
minLength: 8
account-number-code:
title: account-number-code
type: string
enum:
- bban
bank-id:
title: bank-id
description: Must be a UK Sort Code.
type: string
x-allOf:
- type: string
- {}
pattern: ^[0-9]{6}$
maxLength: 6
example: '123456'
minLength: 6
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
account-holder:
title: account-holder
description: The name of the [account holder](http://docs.griffin.com).
type: string
minLength: 1
account-url:
title: account-url
description: Link to the bank account resource.
type: string
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
required:
- account-number
- account-number-code
- bank-id
- bank-id-code
required:
- created-at
- payment-amount
- debtor
- creditor
- payment-url
- payment-direction
PaymentsListAdmissionsResponse:
title: admissions-response
type: object
properties:
admissions:
type: array
items:
title: admission
type: object
properties:
admission-status:
title: admission-status
description: Specifies the progress of the inbound payment.
enum:
- processing
- returned
- delivered
type: string
admission-scheme-information:
title: admission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as
assigned by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
admission-url:
title: admission-url
type: string
example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA
required:
- admission-status
- admission-scheme-information
- payment-url
- created-at
- admission-url
required:
- admissions
PaymentsListSubmissions200Response:
title: submissions-response
type: object
properties:
submissions:
type: array
items:
title: submission
type: object
properties:
submission-status:
title: submission-status
description: Specifies the progress of the outbound payment.
enum:
- failed
- processing
- returned
- delivered
type: string
submission-scheme-information:
title: submission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as
assigned by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
scheme-status-code:
title: scheme-status-code
description: A scheme-specific code describing the current status.
type: string
minLength: 1
scheme-status-code-description:
title: scheme-status-code-description
description: >-
A human-readable description of the scheme status
code.
type: string
minLength: 1
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
submission-url:
title: submission-url
type: string
example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA
required:
- submission-status
- submission-scheme-information
- payment-url
- created-at
- submission-url
required:
- submissions
PaymentsSubmitPaymentSubmissionResponse:
title: submission
type: object
properties:
submission-status:
title: submission-status
description: Specifies the progress of the outbound payment.
enum:
- failed
- processing
- returned
- delivered
type: string
submission-scheme-information:
title: submission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as assigned
by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
scheme-status-code:
title: scheme-status-code
description: A scheme-specific code describing the current status.
type: string
minLength: 1
scheme-status-code-description:
title: scheme-status-code-description
description: A human-readable description of the scheme status code.
type: string
minLength: 1
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
submission-url:
title: submission-url
type: string
example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA
required:
- submission-status
- submission-scheme-information
- payment-url
- created-at
- submission-url
RolesListAllRolesResponse:
title: roles-response
type: object
properties:
roles:
title: roles
description: Shows a collection of [roles](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
required:
- roles
RolesGetRoleResponse:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
PaymentsGetSubmissionResponse:
title: submission
type: object
properties:
submission-status:
title: submission-status
description: Specifies the progress of the outbound payment.
enum:
- failed
- processing
- returned
- delivered
type: string
submission-scheme-information:
title: submission-scheme-information
type: object
properties: {}
required:
- payment-scheme
anyOf:
- title: fps
type: object
properties:
end-to-end-identification:
title: end-to-end-identification
description: >-
Unique and unambiguous identifier for a payment as assigned
by the originator.
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
scheme-status-code:
title: scheme-status-code
description: A scheme-specific code describing the current status.
type: string
minLength: 1
scheme-status-code-description:
title: scheme-status-code-description
description: A human-readable description of the scheme status code.
type: string
minLength: 1
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
- title: internal
type: object
properties:
payment-scheme:
enum:
- internal
type: string
required:
- payment-scheme
payment-url:
title: payment-url
description: Link to the payment resource.
type: string
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
submission-url:
title: submission-url
type: string
example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA
required:
- submission-status
- submission-scheme-information
- payment-url
- created-at
- submission-url
UsersGetUserResourceResponse:
title: user
description: Shows the associated [user](http://docs.griffin.com).
type: object
properties:
user-email:
title: user-email
description: The user's email address.
type: string
example: user@example.com
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
user-username:
title: user-username
description: The username.
type: string
example: user@example.com
api-keys-url:
title: api-keys-url
description: Link to the user's [api keys](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys
user-memberships-url:
title: user-memberships-url
description: Link to the user's [memberships](http://docs.griffin.com).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships
given-name:
type: string
surname:
type: string
required:
- user-email
- user-url
- user-username
- api-keys-url
- user-memberships-url
ApiKeysListActiveKeys200Response:
title: api-keys-response
type: object
properties:
api-keys:
type: array
items:
title: api-key
type: object
properties:
api-key-url:
title: api-key-url
description: The resource path for the API key
type: string
example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
api-key-name:
title: api-key-name
description: The immutable display name for the API key
pattern: ^[a-zA-z0-9-_]+
maxLength: 64
example: buildserver
minLength: 1
api-key-live?:
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- api-key-url
- api-key-name
- api-key-live?
- organization-url
- user-url
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- api-keys
- links
MembershipsListUserMembershipsResponse:
title: memberships-response
type: object
properties:
memberships:
type: array
items:
title: membership
type: object
properties:
membership-url:
title: membership-url
description: Link to the [membership](http://docs.griffin.com).
type: string
example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA
membership-roles-url:
title: membership-roles-url
description: >-
Link to the assigned [roles](http://docs.griffin.com) for this
[membership](http://docs.griffin.com).
type: string
example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles
organization:
title: organization
type: object
properties:
own-legal-person-url:
title: own-legal-person-url
description: >-
Link to the [legal person](http://docs.griffin.com) that
represents the [organization](http://docs.griffin.com);
this can be an individual or a company.
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
organization-mode:
title: organization-mode
description: >-
The organization can either be a sandbox organization or a
live one; Check out our guide for [sandbox mode vs live
mode](http://docs.griffin.com).
enum:
- test-mode
- live-mode
type: string
organization-memberships-url:
title: organization-memberships-url
description: >-
Link to the [memberships](http://docs.griffin.com) for
this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships
organization-invitations-url:
title: organization-invitations-url
description: >-
Link to the resource that enables you to
[invite](http://docs.griffin.com) new
[users](http://docs.griffin.com) to this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations
organization-onboarding-applications-url:
title: organization-onboarding-applications-url
description: >-
Link to the [Reliance
onboarding](http://docs.griffin.com).
type: string
example: >-
/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
organization-api-keys-url:
title: organization-api-keys-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys
organization-live-access-url:
title: organization-live-access-url
description: >-
Link to the resource that enables you to request live
access.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access
organization-webhooks-url:
title: organization-webhooks-url
description: Link to the endpoint which enables webhook creation.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks
organization-workflows-url:
title: organization-workflows-url
description: >-
Link to the onboarding
[workflows](http://docs.griffin.com) configured for this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows
organization-bank-accounts-url:
title: organization-bank-accounts-url
description: >-
Link to the [bank accounts](http://docs.griffin.com)
managed by this [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts
available-roles:
title: available-roles
description: >-
The subset of [roles](http://docs.griffin.com) available
to [members](http://docs.griffin.com) of this
[organization](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
can-decide-on-verifications?:
title: can-decide-on-verifications?
description: >-
Is this organization able to make manual decisions on
verifications?
type: boolean
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
organization-individuals-url:
title: organization-individuals-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals
organization-corporations-url:
title: organization-corporations-url
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations
organization-legal-persons-url:
title: organization-legal-persons-url
description: >-
Link to the [legal persons](http://docs.griffin.com)
grouped under this
[organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons
organization-events-url:
title: organization-events-url
description: Link to the endpoint which lists an organization's events.
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events
required:
- available-roles
- can-decide-on-verifications?
- display-name
- organization-api-keys-url
- organization-bank-accounts-url
- organization-corporations-url
- organization-events-url
- organization-individuals-url
- organization-invitations-url
- organization-legal-persons-url
- organization-live-access-url
- organization-memberships-url
- organization-mode
- organization-url
- organization-webhooks-url
- organization-workflows-url
- own-legal-person-url
roles:
title: roles
description: Shows a collection of [roles](http://docs.griffin.com).
type: array
items:
title: role
type: object
properties:
description:
type: string
display-name:
title: display-name
description: The mutable display name for the Organisation
type: string
minLength: 1
maxLength: 64
example: Company Org
role-url:
title: role-url
description: Link to the [role](http://docs.griffin.com).
type: string
example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA
required:
- display-name
- description
- role-url
user:
title: user
description: Shows the associated [user](http://docs.griffin.com).
type: object
properties:
user-email:
title: user-email
description: The user's email address.
type: string
example: user@example.com
user-url:
title: user-url
description: Link to the user.
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
user-username:
title: user-username
description: The username.
type: string
example: user@example.com
api-keys-url:
title: api-keys-url
description: Link to the user's [api keys](http://docs.griffin.com).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys
user-memberships-url:
title: user-memberships-url
description: Link to the user's [memberships](http://docs.griffin.com).
type: string
example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships
given-name:
type: string
surname:
type: string
required:
- user-email
- user-url
- user-username
- api-keys-url
- user-memberships-url
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- membership-url
- membership-roles-url
- organization
- roles
- user
- created-at
links:
title: links
type: object
properties:
prev:
type: string
nullable: true
next:
type: string
nullable: true
required:
- prev
- next
required:
- memberships
- links
VerificationsGetVerificationResponse:
title: verification
type: object
properties:
verification-url:
title: verification-url
description: A link to the [verification](http://docs.griffin.com).
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
legal-person-url:
title: legal-person-url
description: A contextual link to the [legal person](http://docs.griffin.com).
type: string
example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
verification-checks-url:
title: verification-checks-url
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/checks
risk-rating:
title: risk-rating
type: string
enum:
- high-risk
- prohibited-risk
- medium-risk
- low-risk
verification-status:
title: verification-status
type: string
enum:
- in-progress
- pending
- checks-declined
- checks-complete
- failed
verification-risk-assessments-url:
title: verification-risk-assessments-url
type: string
example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/risk-assessments
required:
- created-at
- legal-person-url
- verification-status
- verification-url
- verification-checks-url
WebhooksGetWebhookResponse:
title: webhook
type: object
properties:
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
webhook-url:
title: webhook-url
description: Link to the [webhook](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
test-webhook-url:
title: test-webhook-url
description: Test a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test
activate-webhook-url:
title: activate-webhook-url
description: Activate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate
deactivate-webhook-url:
title: deactivate-webhook-url
description: Deactivate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- organization-url
- webhook-url
- webhook-destination-url
- test-webhook-url
- activate-webhook-url
- deactivate-webhook-url
WebhooksUpdateWebhookResponse:
title: webhook
type: object
properties:
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
webhook-url:
title: webhook-url
description: Link to the [webhook](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
test-webhook-url:
title: test-webhook-url
description: Test a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test
activate-webhook-url:
title: activate-webhook-url
description: Activate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate
deactivate-webhook-url:
title: deactivate-webhook-url
description: Deactivate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- organization-url
- webhook-url
- webhook-destination-url
- test-webhook-url
- activate-webhook-url
- deactivate-webhook-url
WebhooksActivateActionResponse:
title: webhook
type: object
properties:
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
webhook-url:
title: webhook-url
description: Link to the [webhook](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
test-webhook-url:
title: test-webhook-url
description: Test a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test
activate-webhook-url:
title: activate-webhook-url
description: Activate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate
deactivate-webhook-url:
title: deactivate-webhook-url
description: Deactivate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- organization-url
- webhook-url
- webhook-destination-url
- test-webhook-url
- activate-webhook-url
- deactivate-webhook-url
WebhooksDeactivateActionResponse:
title: webhook
type: object
properties:
organization-url:
title: organization-url
description: Link to the [organization](http://docs.griffin.com).
type: string
example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
webhook-url:
title: webhook-url
description: Link to the [webhook](http://docs.griffin.com).
type: string
minLength: 1
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA
webhook-destination-url:
title: webhook-destination-url
description: The callback URL of the webhook
type: string
x-allOf:
- type: string
- {}
example: https://example.com/griffin/webhook/
test-webhook-url:
title: test-webhook-url
description: Test a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test
activate-webhook-url:
title: activate-webhook-url
description: Activate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate
deactivate-webhook-url:
title: deactivate-webhook-url
description: Deactivate a webhook
type: string
example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate
webhook-description:
title: webhook-description
description: A description of the webhook
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
example: Griffin API webhook
required:
- organization-url
- webhook-url
- webhook-destination-url
- test-webhook-url
- activate-webhook-url
- deactivate-webhook-url
WebhooksGetLatestTestStatusResponse:
title: webhook-test-response
type: object
properties: {}
required:
- webhook-request-status
anyOf:
- title: default
type: object
properties:
webhook-request-status:
enum:
- default
type: string
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- webhook-request-status
- updated-at
- webhook-request-status
- title: complete
type: object
properties:
webhook-request-status:
enum:
- complete
type: string
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
webhook-http-status:
type: integer
format: int64
x-allOf:
- type: integer
format: int64
- minimum: 100
maximum: 800
webhook-error-code:
title: webhook-error-code
type: string
enum:
- webhook-timeout
- webhook-unknown-host
- webhook-unknown-error
- webhook-invalid-response
required:
- webhook-request-status
- updated-at
- webhook-http-status
- webhook-error-code
- webhook-request-status
WebhooksSendTestEventResponse:
title: webhook-test-response
type: object
properties: {}
required:
- webhook-request-status
anyOf:
- title: default
type: object
properties:
webhook-request-status:
enum:
- default
type: string
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required:
- webhook-request-status
- updated-at
- webhook-request-status
- title: complete
type: object
properties:
webhook-request-status:
enum:
- complete
type: string
updated-at:
title: updated-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
webhook-http-status:
type: integer
format: int64
x-allOf:
- type: integer
format: int64
- minimum: 100
maximum: 800
webhook-error-code:
title: webhook-error-code
type: string
enum:
- webhook-timeout
- webhook-unknown-host
- webhook-unknown-error
- webhook-invalid-response
required:
- webhook-request-status
- updated-at
- webhook-http-status
- webhook-error-code
- webhook-request-status
WorkflowsGetWorkflowResponse:
title: workflow
type: object
properties:
workflow-url:
title: workflow-url
description: A link to the [workflow](http://docs.griffin.com).
type: string
example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
display-name:
title: display-name
description: A human readable label for an entity
type: string
minLength: 1
legal-person-type:
title: legal-person-type
description: Specifies if the legal person is an `individual` or a `corporation`.
enum:
- individual
- corporation
type: string
created-at:
title: created-at
description: ISO 8601 formatted date-time.
format: date-time
type: string
required-claim-types:
title: required-claim-types
description: |-
A mapping of workflow-appropriate legal person types
to claims that are required for each type.
type: object
additionalProperties:
type: array
items:
title: claim-type
type: string
enum:
- mobile-number
- individual-identity
- sole-trader
- uk-company-register
- individual-income
- business-website
- initial-deposit
- international-payments-countries
- company-telephone-number
- managed-properties
- person-with-significant-control
- business-industry
- tenant-cash-payments
- verified-bank-account
- company-email-address
- tax-residency
- uk-financial-services-register
- non-tenant-balance
- business-description
- hmrc-register
- vat-registration
- business-email-address
- client-money-protection-scheme
- individual-sources-of-funds
- nominal-person-with-significant-control
- hmo-verification
- business-address
- employment
- annual-turnover
- purposes-of-account
- sic-codes
- international-operations-countries
- sources-of-funds
- business-owner
- business-telephone-number
- individual-email-address
- business-start-date
- contact-details
- reliance-verification
- ultimate-beneficial-owner
- business-name
- individual-purposes-of-account
- nationality
- trading-name
- number-of-employees
- social-media
- trading-address
- company-website
- director
- alternative-number
- cash-payments
- tax-identification-number
- individual-residence
uniqueItems: true
workflow-rules:
title: workflow-rules
description: A list of special behaviours a workflow can possess.
type: array
items:
type: string
enum:
- allow-zero-directors
- allow-missing-directors
uniqueItems: true
required:
- workflow-url
- display-name
- legal-person-type
- created-at
security:
- api-key-auth: []
x-tagGroups:
- tags:
- API keys
- Connectivity
- Navigation
- Events
- Webhooks
name: Getting started
- tags:
- Legal persons
- Legal person history
- Claims
- Workflows
- Verifications
- Decisions
- Companies House
- Reliance onboarding
name: Customer verifications
- tags:
- Bank accounts
- Pooled account membership
- Payments
- Transactions
- Payees
name: Banking
- tags:
- Organizations
- Users
- Roles
- Memberships
- Invitations
name: Team management
x-id:
- default