consumes: - application/json security: - api-key-auth: [] basePath: / host: api.griffin.com x-tagGroups: - name: Getting started tags: - API keys - Connectivity - Navigation - Events - Webhooks - Message Signatures - name: Customer verifications tags: - Legal persons - Legal person history - Claims - Workflows - Verifications - Decisions - Companies House - Reliance onboarding - name: Banking tags: - Bank accounts - Bank account events - Bank account restrictions - Bank account holds - Pooled account membership - Payments - Transactions - Payees - Confirmation of payee - Open banking - name: Team management tags: - Organizations - Users - Roles - Memberships - Invitations info: title: The Griffin API version: '' 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](#tag/Bank-accounts) 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 our API in [sandbox mode](/docs/guides/sandbox-vs-live-mode). New to Griffin? Check out our [getting started guide](/docs/guides/get-started-with-the-api). ## 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](#tag/Organizations) at the top. Everything that you own will be a sub-resource of your organization. To bootstrap the navigation process, request the [index](#tag/Navigation/paths/~1v0~1index/get) endpoint: the response will contain your `organization-url`. For a walkthrough, see our [getting started guide](/docs/guides/get-started-with-the-api). ## Pagination Our list APIs support pagination (e.g. [list bank accounts](#tag/Bank-accounts/paths/~1v0~1organizations~1%7Borganization-id%7D~1bank~1accounts/get) and [list payments](#tag/Payments/paths/~1v0~1bank~1accounts~1%7Bbank-account-id%7D~1payments/get)). 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](#section/Filtering-and-sorting)), 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 ## Request limits Each organization is allowed up to 50 concurrent (in-flight) API requests. Exceeding this threshold results in a 429 - Too Many Requests response. Upon receiving a 429 response, you should implement a backoff strategy, pausing to allow your outstanding requests to complete before attempting new requests. To manage your request rate effectively and avoid surpassing this limit, consider using a controlled approach such as a finite pool of threads or workers. ## 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. tags: - name: Getting started - name: Customer verifications - name: Legal persons description: >- In the Griffin API, your organization and your customers are all represented by [legal persons](/docs/terms/legal-person). 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](/docs/terms/director) or [person with significant control](/docs/terms/person-with-significant-control) attached to it, who must also be represented as a distinct `individual` legal person. - name: Claims description: >- A [claim](/docs/terms/claim) is an unverified data point or series of data points attached to a [legal person](#tag/Legal-persons). Claims are verified by running a [verification](#tag/Verifications) against the legal person. - name: Workflows description: >- A [workflow](/docs/terms/workflow) determines which checks will be run against a [legal person](#tag/Legal-persons) as part of a [verification](#tag/Verifications) - name: Reliance onboarding 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, checkout our [onboarding guides](https://docs.griffin.com/docs/tags/onboarding). - name: Bank accounts description: > Bank accounts are used for managing funds. Every bank account is opened against a [bank product](/docs/guides/bank-products), which determines the account's behaviour (type, pooled vs dedicated, interest, notice period, etc.). Some account types are for managing your own funds and some are for managing your customers' funds. For information, check out our guides: - [Opening a bank account](/docs/guides/opening-a-bank-account). - [Bank products](/docs/guides/bank-products). - [Types of bank account](/docs/guides/types-of-bank-accounts). - name: Payments 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](#tag/Bank-accounts) to a [payee](#tag/Payees). 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 [sending payments](/docs/guides/sending-payments) - name: Transactions description: |- A transaction represents funds deposited or withdrawn from a bank account. Read more about transactions [in our guides](/docs/guides/transactions). - name: Payees 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"`). You may also register the outcome of a [Confirmation of Payee (CoP) check](#tag/Confirmation-of-payee) with your payee by supplying a `cop-request-url`. Read more about payees [in our guides](/docs/guides/create-a-payee). - name: Confirmation of Payee description: >- Confirmation of Payee (CoP) is a payee checking service that helps prevent UK domestic payments from being sent to the wrong account. Read more about Confirmation of Payee [in our guides](/docs/guides/confirmation-of-payee). - name: Bank account restrictions description: >- Restrictions prevent payments on a bank account. A `freeze` blocks outbound payments while still allowing inbound payments. A `block` prevents both inbound and outbound payments. Restrictions can be applied at any point in the account lifecycle (`opening`, `open`, `closing`, or `closed`), and multiple restrictions can be active on the same account simultaneously. Each restriction is independent — lifting one does not affect others. Restrictions can only be updated or lifted if `active`. For more information, see our guide on [managing restrictions](/docs/guides/managing-restrictions). - name: Organizations description: >- The organization resource represents your company and acts as a container for the majority of other resources, including [legal persons](#tag/Legal-Persons) and [bank accounts](#tag/Bank-accounts). When you register for an account with Griffin, a new [organization](#tag/Organizations) is created alongside your [user](#tag/Users) account (unless you have received an [invitation](#tag/Invitations) to join an existing organization). Your [user](#tag/Users) account is associated with an [organization](#tag/Organizations) via a [membership](#tag/Memberships). Your [organization](#tag/Organization) 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](/docs/guides/sandbox-vs-live-mode). - name: Users description: >- Users represent individuals who use the Griffin platform. A user must have a [membership](#tag/Memberships) in at least one [organization](#tag/Organizations), and may have memberships in multiple organizations. - name: Memberships description: >- Memberships represents the relationship between a [user](#tag/Users) and an [organization](#tag/Organizations). A membership must have at least one [role](#tag/Roles) assigned to it. - name: Invitations description: >- Invitations enable [users](#tag/Users) to create new [memberships](#tag/Memberships) for their [organization](#tag/Organizations). 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](#tag/Roles) with the most limited set of capabilities by default. - name: Roles description: >- A role represents a pre-defined set of capabilities that can be assigned to a [user](#tag/Users) via their [membership](#tag/Memberships) in an [organization](#tag/Organization). By default, the first user in an organization gets assigned an administration role. Subsequent users get assigned the most limited set of capabilities. - name: API keys 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](#tag/Organizations). If you are a [member](#tag/Memberships) 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: Open banking description: >- Open banking allows regulated third-party providers (TPPs) to access your customers' account data or initiate payments on their behalf. Griffin partners with [tell.money](https://tell.money/) to provide the TPP-facing open banking APIs. You handle the consent flow — authenticating your customer and registering the consent with Griffin — and Griffin handles the resource requests from TPPs. For a full walkthrough, see our [open banking integration guide](/docs/guides/open-banking-customer-accounts). - name: Message Signatures description: >- Message Signatures confirm the identity of the sender and integrity of request messages. Key points: - Uses Ed25519 algorithm - Requires registering a public key with Griffin - Signatures cover specific message components - Includes `Signature-Input` and `Signature` headers [How to create message signatures](/docs/guides/how-to-create-message-signatures) provides a detailed guide. paths: /v0/index: get: tags: - Navigation description: >- Contains various global URL paths. Follow `api-key-url` to discover your `organization-url`. responses: '200': schema: type: object properties: organizations-url: type: string title: organizations-url example: /v0/organizations description: Link to the [organization](#tag/Organizations). users-url: type: string title: users-url example: /v0/users roles-url: type: string title: roles-url example: /v0/roles session-url: type: string x-allOf: - type: string - {} - type: object properties: {} x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: {} - type: string x-allOf: - type: string - {} - type: object properties: {} title: session-url example: /v0/session api-key-url: type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id title: api-key-url description: The resource path for the API key example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). required: - organizations-url - users-url - roles-url title: index description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: Index parameters: [] /v0/ping: get: tags: - Connectivity description: Check your connection to the Griffin API. security: [] responses: '204': description: No content summary: Ping parameters: [] /v0/admissions/{admission-id}: get: tags: - Payments description: Yields an admission. parameters: - type: string required: true name: admission-id in: path responses: '200': schema: type: object properties: admission-status: title: admission-status enum: - cancelled - processing - returned - delivered type: string description: Specifies the progress of the inbound payment. admission-scheme-information: type: object properties: {} required: - payment-scheme title: admission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer - type: object properties: payment-scheme: enum: - chaps type: string title: chaps required: - payment-scheme - type: object properties: payment-scheme: enum: - bacs type: string title: bacs required: - payment-scheme payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. admission-url: type: string title: admission-url example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. original-unique-scheme-identifier: type: string title: original-unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 required: - admission-status - admission-scheme-information - payment-url - created-at - admission-url - unique-scheme-identifier - account-url title: admission description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' summary: Get payment admission /v0/api-keys/{api-key-id}: get: tags: - API keys description: Returns the API key without `api-key-secret`. parameters: - type: string required: true name: api-key-id in: path responses: '200': schema: type: object properties: api-key-url: type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id title: api-key-url description: The resource path for the API key example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA api-key-name: title: api-key-name pattern: ^[a-zA-z0-9-_]+ description: The immutable display name for the API key maxLength: 64 example: buildserver minLength: 1 api-key-live?: type: boolean organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - api-key-url - api-key-name - api-key-live? - organization-url - user-url - created-at title: api-key description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get API key delete: tags: - API keys description: Deletes the API Key. This operation cannot be undone. parameters: - type: string required: true name: api-key-id in: path responses: '204': description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: '' summary: Delete API key /v0/bank/account-restrictions/{bank-account-restriction-id}: get: tags: - Bank account restrictions description: >- Fetches details of a single bank account restriction. The response includes the restriction's current status (`active` or `lifted`), type, reason code, legal status, and who applied it. If the restriction was applied by Griffin using a sensitive reason code (`griffin-decision`, `law-enforcement`, `sanctions`, or `terrorist-financing`), the type, reason code, and legal status fields are omitted from the response. Action URLs (`update-bank-account-restriction-url`, `lift-bank-account-restriction-url`) are included only when you are authorised to perform those actions on the restriction. parameters: - type: string required: true name: bank-account-restriction-id in: path responses: '200': schema: type: object properties: lift-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: lift-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/lift description: Link to lift a bank account restriction. restriction-status: type: string title: restriction-status x-anyOf: - type: string enum: - lifted - active - type: string restriction-legal-status: type: string title: restriction-legal-status x-anyOf: - type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected - type: string bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw description: Link to a bank account restriction. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. update-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: update-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/update description: Link to update a bank account restriction. bank-account-restriction-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-events-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/events description: Link to events for a bank account restriction. restriction-reason-code: type: string title: restriction-reason-code x-anyOf: - type: string enum: - suspicious - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud - high-risk-pep - fraud-1st-party - type: string restriction-type: type: string title: restriction-type x-anyOf: - type: string enum: - block - freeze - type: string account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. restriction-applied-by: type: object properties: {} required: - restriction-applied-by-type title: restriction-applied-by x-anyOf: - type: object properties: restriction-applied-by-type: enum: - ops-user type: string required: - restriction-applied-by-type - restriction-applied-by-type title: ops-user - type: object properties: restriction-applied-by-type: enum: - user type: string user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. required: - restriction-applied-by-type - user-url - restriction-applied-by-type title: user required: - bank-account-restriction-url - bank-account-restriction-events-url - restriction-status - restriction-applied-by - created-at - account-url title: bank-account-restriction-response description: A bank account restriction. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get bank account restriction /v0/bank/account-restrictions/{bank-account-restriction-id}/actions/lift: post: tags: - Bank account restrictions description: >- Lifts a bank account restriction. Marks the restriction as `lifted`, removing its effect on the account. Notes are required to provide context for the removal. parameters: - in: body name: request-lift-restriction description: '' required: true schema: type: object properties: notes: type: string maxLength: 2000 required: - notes title: request-lift-restriction - type: string required: true name: bank-account-restriction-id in: path responses: '200': schema: type: object properties: lift-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: lift-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/lift description: Link to lift a bank account restriction. restriction-status: type: string title: restriction-status x-anyOf: - type: string enum: - lifted - active - type: string restriction-legal-status: type: string title: restriction-legal-status x-anyOf: - type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected - type: string bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw description: Link to a bank account restriction. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. update-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: update-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/update description: Link to update a bank account restriction. bank-account-restriction-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-events-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/events description: Link to events for a bank account restriction. restriction-reason-code: type: string title: restriction-reason-code x-anyOf: - type: string enum: - suspicious - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud - high-risk-pep - fraud-1st-party - type: string restriction-type: type: string title: restriction-type x-anyOf: - type: string enum: - block - freeze - type: string account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. restriction-applied-by: type: object properties: {} required: - restriction-applied-by-type title: restriction-applied-by x-anyOf: - type: object properties: restriction-applied-by-type: enum: - ops-user type: string required: - restriction-applied-by-type - restriction-applied-by-type title: ops-user - type: object properties: restriction-applied-by-type: enum: - user type: string user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. required: - restriction-applied-by-type - user-url - restriction-applied-by-type title: user required: - bank-account-restriction-url - bank-account-restriction-events-url - restriction-status - restriction-applied-by - created-at - account-url title: bank-account-restriction-response description: A bank account restriction. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' '422': description: The restriction is not active or can only be lifted by Griffin '500': description: '' summary: Lift bank account restriction /v0/bank/account-restrictions/{bank-account-restriction-id}/actions/update: post: tags: - Bank account restrictions description: >- Updates a bank account restriction. Allows you to change the restriction type, reason code, and/or legal status of an active restriction. Notes are always required to provide context for the change. Only the fields you include in the request body will be updated. Omitted fields are left unchanged. parameters: - in: body name: request-update-restriction description: '' required: true schema: type: object properties: restriction-type: type: string enum: - block - freeze restriction-reason-code: type: string enum: - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud-1st-party restriction-legal-status: type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected notes: type: string maxLength: 2000 required: - notes title: request-update-restriction - type: string required: true name: bank-account-restriction-id in: path responses: '200': schema: type: object properties: lift-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: lift-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/lift description: Link to lift a bank account restriction. restriction-status: type: string title: restriction-status x-anyOf: - type: string enum: - lifted - active - type: string restriction-legal-status: type: string title: restriction-legal-status x-anyOf: - type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected - type: string bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw description: Link to a bank account restriction. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. update-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: update-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/update description: Link to update a bank account restriction. bank-account-restriction-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-events-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/events description: Link to events for a bank account restriction. restriction-reason-code: type: string title: restriction-reason-code x-anyOf: - type: string enum: - suspicious - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud - high-risk-pep - fraud-1st-party - type: string restriction-type: type: string title: restriction-type x-anyOf: - type: string enum: - block - freeze - type: string account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. restriction-applied-by: type: object properties: {} required: - restriction-applied-by-type title: restriction-applied-by x-anyOf: - type: object properties: restriction-applied-by-type: enum: - ops-user type: string required: - restriction-applied-by-type - restriction-applied-by-type title: ops-user - type: object properties: restriction-applied-by-type: enum: - user type: string user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. required: - restriction-applied-by-type - user-url - restriction-applied-by-type title: user required: - bank-account-restriction-url - bank-account-restriction-events-url - restriction-status - restriction-applied-by - created-at - account-url title: bank-account-restriction-response description: A bank account restriction. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' '422': description: The restriction is not active or can only be updated by Griffin '500': description: '' summary: Update bank account restriction /v0/bank/accounts/{bank-account-id}: get: tags: - Bank accounts description: Fetch a bank account parameters: - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url description: >- Link to the [payments](#tag/Payments) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account maxLength: 64 example: Reserve a/c controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url description: Link to the events for this bank account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account headers: Location: type: string description: The URL of the bank account description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get bank account patch: tags: - Bank accounts description: Update a bank account parameters: - in: body name: request-update-bank-account description: '' required: true schema: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity required: - display-name title: request-update-bank-account - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url description: >- Link to the [payments](#tag/Payments) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account maxLength: 64 example: Reserve a/c controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url description: Link to the events for this bank account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account headers: Location: type: string description: The URL of the bank account description: '' '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: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/bank/accounts/{bank-account-id}/actions/close: post: tags: - Bank accounts description: Close a bank account parameters: - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url description: >- Link to the [payments](#tag/Payments) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account maxLength: 64 example: Reserve a/c controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url description: Link to the events for this bank account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account headers: Location: type: string description: The URL of the bank account description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '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 description: Lists admissions targeting a bank account parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: filter[created-at][lte] description: >- Return only resources with a created-at less than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][lt] description: >- Return only resources with a created-at less than the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gte] description: >- Return only resources with a created-at greater than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gt] description: >- Return only resources with a created-at greater than the given timestamp. type: string required: false format: date-time - in: query name: filter[admission-status][in][] description: '' type: array required: false x-allOf: - {} - {} items: enum: - cancelled - processing - returned - delivered type: string - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: admissions: type: array items: type: object properties: admission-status: title: admission-status enum: - cancelled - processing - returned - delivered type: string description: Specifies the progress of the inbound payment. admission-scheme-information: type: object properties: {} required: - payment-scheme title: admission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer - type: object properties: payment-scheme: enum: - chaps type: string title: chaps required: - payment-scheme - type: object properties: payment-scheme: enum: - bacs type: string title: bacs required: - payment-scheme payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. admission-url: type: string title: admission-url example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. original-unique-scheme-identifier: type: string title: original-unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 required: - admission-status - admission-scheme-information - payment-url - created-at - admission-url - unique-scheme-identifier - account-url title: admission links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - admissions - links title: admissions-paginated-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List bank account admissions /v0/bank/accounts/{bank-account-id}/holds: get: tags: - Bank account holds description: |- Lists all holds on a bank account. Use `filter[status][in][]` to filter by specific statuses. Use `filter[updated-at][gte]` to return only holds last updated at or after a timestamp. Use `filter[origin-type][eq]` to filter by origin type. parameters: - in: query name: filter[origin-type][eq] description: '' type: string required: false enum: - card-transaction - in: query name: filter[updated-at][gte] description: Return only holds updated at or after the given timestamp. type: string required: false format: date-time - in: query name: filter[status][in][] description: '' type: array required: false items: type: string enum: - released - placed - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: holds: type: array items: type: object properties: expires-at: title: expires-at format: date-time type: string description: ISO 8601 formatted date-time. origin-type: title: origin-type type: string enum: - card-transaction updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. origin-metadata: type: object additionalProperties: type: string title: origin-metadata description: >- Identifiers from the system that originated the hold or transaction. Keys and values are originator-specific. direction: title: direction type: string enum: - debit - credit status: title: status type: string enum: - released - placed created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. release-reason: type: string title: release-reason description: >- The final release reason (e.g. clearing, expiry, reversal amount: title: amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. hold-url: type: string x-allOf: - type: string - {} - type: object properties: hold-id: type: string format: '' title: hold-id required: true name: hold-id required: - hold-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: hold-id: type: string format: '' title: hold-id required: true name: hold-id required: - hold-id - type: string x-allOf: - type: string - {} - type: object properties: hold-id: type: string format: '' title: hold-id required: true name: hold-id required: - hold-id title: hold-url example: /v0/bank/holds/ho.ICAgICAgICAgaG9sZC1pZA description: Link to this hold. account-transactions: type: array items: type: object properties: account-transaction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id title: account-transaction-url description: Link to the transaction resource. updated-hold-at: format: date-time type: string description: When this account transaction updated the hold. title: updated-hold-at required: - account-transaction-url - updated-hold-at title: account-transaction description: An account transaction associated with this hold. title: account-transactions description: All account transactions associated with this hold. required: - hold-url - account-url - status - amount - direction - created-at - updated-at - origin-type title: hold description: A hold on a bank account. links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - holds - links title: holds-response description: All holds which have ever been placed on the bank account. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/bank/accounts/{bank-account-id}/membership: get: tags: - Pooled account membership description: List legal persons in a pooled account membership parameters: - in: query name: include 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. type: array required: false x-allOf: - {} - {} items: enum: - latest-risk-rating - legal-person - latest-verification type: string - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: pool-members: type: array items: type: object properties: created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA required: - created-at - legal-person-url title: pool-member links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta included: type: object properties: verifications: type: array items: type: object properties: verification-profiles-url: type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id title: verification-profiles-url description: >- Get claims used in this [verification](#tag/Verifications) for all associated [legal persons](/docs/terms/legal-person). example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/profiles verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). verification-resources-url: type: string title: verification-resources-url example: >- /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/resources description: >- A link to the resources of a [verification](#tag/Verifications). updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. verification-checks-url: type: string title: verification-checks-url 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: type: string title: verification-risk-assessments-url example: >- /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/risk-assessments required: - created-at - legal-person-url - verification-status - verification-url - verification-checks-url title: verification risk-rating-entries: type: array items: type: object properties: risk-rating-url: type: string title: risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. risk-rating: title: risk-rating type: string enum: - high-risk - prohibited-risk - medium-risk - low-risk legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA notes: type: string minLength: 1 title: notes description: Rationale for overriding the risk rating. manually-created-by: type: object properties: {} required: - manually-created-by-type title: manually-created-by description: User that triggered this event. x-anyOf: - type: object properties: manually-created-by-type: enum: - ops-user type: string required: - manually-created-by-type - manually-created-by-type title: ops-user verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). 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 title: risk-rating-entry legal-persons: type: array items: type: object properties: latest-decision: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: >- A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: >- Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: latest-decision description: The most recent [decision](#tag/Decisions) legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. latest-risk-rating-url: type: string title: latest-risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity application-status: title: application-status enum: - referred - errored - declined - submitted - accepted type: string description: >- Status of the current [application](/docs/terms/application) legal-person-status: title: legal-person-status enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string description: Status of the [legal person](#tag/Legal-persons) legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA legal-person-decisions-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-decisions-url description: >- Link to [decisions](#tag/Decisions) for this [legal person](/docs/terms/legal-person). example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions status-changed-at: title: status-changed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-claims-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-claims-url description: >- Link to the [claims](#tag/Claims) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims legal-person-bank-payees-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-bank-payees-url description: >- Link to the [payees](#tag/Payees) for this [legal person](/docs/terms/legal-person). example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees legal-person-verifications-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-verifications-url description: >- Link to all [verifications](#tag/Verifications) run against this [legal person](/docs/terms/legal-person). example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications legal-name: type: string title: legal-name description: >- A read-only, human readable label derived from claims legal-person-documents-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-documents-url description: >- Link to all evidence documents associated with this [legal person](/docs/terms/legal-person). 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 title: legal-person title: '' description: Present only when the request uses the `include` parameter. required: - links - pool-members description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' summary: List legal person in a pooled account membership /v0/bank/accounts/{bank-account-id}/membership-updates: post: tags: - Pooled account membership description: >- Add and update the legal persons in a pooled account membership. Limited to 1000 legal persons per operation. parameters: - in: body name: request-pooled-account-membership-updates description: '' required: true schema: type: object properties: additions: type: array items: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). deletions: type: array items: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). required: - additions - deletions title: request-pooled-account-membership-updates - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership required: - pooled-account-memberships-url title: update-pooled-account-memberships-response description: '' '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: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' '422': description: '' summary: Manage pooled account members /v0/bank/accounts/{bank-account-id}/payments: get: tags: - Payments description: Lists payments made from a bank account. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: include description: >- For each payment returned, include its bank account, latest submission (if one exists), rejecting user (if one exists), and/or creating user (if one exists) in the response under the `included` attribute. type: array required: false x-allOf: - {} - {} items: enum: - bank-account - rejected-by - latest-submission.created-by - created-by - latest-submission type: string - in: query name: filter[rejected][eq] description: >- Specifies whether the payment has been [rejected](/docs/guides/payment-approvals). type: boolean required: false - in: query name: filter[payment-direction][eq] description: Whether the payment is moving money into or out of the account. type: string required: false enum: - inbound-payment - outbound-payment - in: query name: filter[latest-submission-status][in][] description: '' type: array required: false x-allOf: - {} - {} items: enum: - scheduled - failed - processing - returned - delivered type: string x-anyOf: - title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. - enum: - 'null' type: string title: no-latest-submission-status description: No latest submission status - in: query name: filter[created-at][lte] description: >- Return only resources with a created-at less than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][lt] description: >- Return only resources with a created-at less than the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gte] description: >- Return only resources with a created-at greater than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gt] description: >- Return only resources with a created-at greater than the given timestamp. type: string required: false format: date-time - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: payments: type: array items: type: object properties: creditor: type: object properties: {} required: - creditor-type title: creditor x-anyOf: - type: object properties: account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. creditor-type: enum: - griffin-bank-account type: string required: - account-url - creditor-type title: griffin-bank-account - type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: >- [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true creditor-type: enum: - uk-domestic type: string bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: >- Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: - creditor-type title: uk-domestic description: Creditor specified with bank details rejected-at: title: rejected-at format: date-time type: string description: ISO 8601 formatted date-time. latest-submission-url: type: string example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA title: latest-submission-url description: Most recent submission (if any made) rejected-by-url: type: string title: rejected-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. payment-direction: title: payment-direction enum: - inbound-payment - outbound-payment type: string description: >- Whether the payment is moving money into or out of the account. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-via: title: created-via type: string enum: - api - ui created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. payment-reference: title: payment-reference type: string description: >- Free-text field to help identify and categorise payments. maxLength: 35 example: test reference minLength: 1 payment-amount: title: payment-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false x-allOf: - title: money-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false - x-allOf: - x-allOf: - {} - {} - {} description: >- Compound value representing both the currency and amount of money being sent. ultimate-debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor payment-admissions-url: type: string title: payment-admissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions description: Link to the endpoint for listing payment admissions. payment-submissions-url: type: string title: payment-submissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions description: >- Link to the endpoint for creating and listing payment submissions. debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor rejection-reason: title: non-empty-string type: string minLength: 1 x-nullable: true required: - created-at - payment-amount - payment-url - payment-direction title: payment links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - links - payments title: '' description: Present only when the request uses the `include` parameter. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List bank account payments post: tags: - Payments description: Registers a new payment request for the bank account parameters: - in: body name: request-create-payment description: '' required: true schema: type: object properties: creditor: type: object properties: {} required: - creditor-type title: creditor x-anyOf: - type: object properties: payee-url: type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id title: payee-url example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA description: Link to the [payee](#tag/Payees). creditor-type: enum: - payee type: string required: - payee-url - creditor-type title: payee - type: object properties: account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. creditor-type: enum: - griffin-bank-account type: string required: - account-url - creditor-type title: griffin-bank-account - type: object properties: account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 creditor-type: enum: - uk-domestic type: string account-number-code: title: account-number-code type: string enum: - bban required: - creditor-type - account-holder - bank-id - bank-id-code - account-number-code - account-number title: uk-domestic description: Creditor specified with bank details payment-amount: title: payment-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false x-allOf: - title: money-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false - x-allOf: - x-allOf: - {} - {} - {} description: >- Compound value representing both the currency and amount of money being sent. payment-reference: title: payment-reference type: string description: >- Free-text field to help identify and categorise payments. X is the legal person who owns the account. This will be the `entity-name` or `business-name` for companies, or the `given-name` and `surname` for individuals. This is also subject to a 35 character limit, so longer names may be cut off. When making a payment to a payee with an associated Confirmation of Payee request containing secondary reference data (SRD), the SRD will take precedence over any `payment-reference` set in the payment creation request. maxLength: 35 example: test reference minLength: 1 default: Sent from X required: - creditor - payment-amount title: request-create-payment - type: string required: true name: bank-account-id in: path responses: '201': schema: type: object properties: created-by-user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: created-by-user description: Shows the associated [user](#tag/Users). creditor: type: object properties: {} required: - creditor-type title: creditor x-anyOf: - type: object properties: account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. creditor-type: enum: - griffin-bank-account type: string required: - account-url - creditor-type title: griffin-bank-account - type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true creditor-type: enum: - uk-domestic type: string bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: - creditor-type title: uk-domestic description: Creditor specified with bank details rejected-at: title: rejected-at format: date-time type: string description: ISO 8601 formatted date-time. latest-submission-url: type: string example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA title: latest-submission-url description: Most recent submission (if any made) rejected-by-url: type: string title: rejected-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. payment-direction: title: payment-direction enum: - inbound-payment - outbound-payment type: string description: >- Whether the payment is moving money into or out of the account. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-via: title: created-via type: string enum: - api - ui created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. payment-reference: title: payment-reference type: string description: Free-text field to help identify and categorise payments. maxLength: 35 example: test reference minLength: 1 payment-amount: title: payment-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false x-allOf: - title: money-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false - x-allOf: - x-allOf: - {} - {} - {} description: >- Compound value representing both the currency and amount of money being sent. ultimate-debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor payment-admissions-url: type: string title: payment-admissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions description: Link to the endpoint for listing payment admissions. payment-submissions-url: type: string title: payment-submissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions description: >- Link to the endpoint for creating and listing payment submissions. debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor rejection-reason: title: non-empty-string type: string minLength: 1 x-nullable: true rejected-by-user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: rejected-by-user description: Shows the associated [user](#tag/Users). required: - created-at - payment-amount - payment-direction - payment-url description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '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: '' summary: Create payment /v0/bank/accounts/{bank-account-id}/restrictions: get: tags: - Bank account restrictions description: >- Lists restrictions on a bank account. Returns all restrictions (both `active` and `lifted`) by default. Use `filter[restriction-status][eq]=active` to return only active restrictions. See [get restriction](#tag/Bank-account-restrictions/paths/~1v0~1bank~1account-restrictions~1%7Bbank-account-restriction-id%7D/get) for details on field visibility and redaction. parameters: - in: query name: filter[restriction-status][eq] description: Return only restrictions with the given restriction-status. type: string required: false enum: - lifted - active - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: bank-account-restrictions: type: array items: type: object properties: lift-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: lift-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/lift description: Link to lift a bank account restriction. restriction-status: type: string title: restriction-status x-anyOf: - type: string enum: - lifted - active - type: string restriction-legal-status: type: string title: restriction-legal-status x-anyOf: - type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected - type: string bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw description: Link to a bank account restriction. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. update-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: update-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/update description: Link to update a bank account restriction. bank-account-restriction-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-events-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/events description: Link to events for a bank account restriction. restriction-reason-code: type: string title: restriction-reason-code x-anyOf: - type: string enum: - suspicious - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud - high-risk-pep - fraud-1st-party - type: string restriction-type: type: string title: restriction-type x-anyOf: - type: string enum: - block - freeze - type: string account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. restriction-applied-by: type: object properties: {} required: - restriction-applied-by-type title: restriction-applied-by x-anyOf: - type: object properties: restriction-applied-by-type: enum: - ops-user type: string required: - restriction-applied-by-type - restriction-applied-by-type title: ops-user - type: object properties: restriction-applied-by-type: enum: - user type: string user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. required: - restriction-applied-by-type - user-url - restriction-applied-by-type title: user required: - bank-account-restriction-url - bank-account-restriction-events-url - restriction-status - restriction-applied-by - created-at - account-url title: bank-account-restriction-response description: A bank account restriction. links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - bank-account-restrictions - links title: bank-account-restrictions-response description: A list of bank account restrictions. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List bank account restrictions post: tags: - Bank account restrictions description: >- Applies a restriction to a bank account. ### Reason codes | Code | Description | |---|---| | `customer-request` | Account holder requested temporary restriction pending further instruction. | | `deceased` | Account holder confirmed deceased. Restricted pending estate administration. | | `dormant` | Account inactive for 2+ years (no customer-initiated transactions). | | `fraud-1st-party` | Account holder is suspected perpetrator committing fraud against Griffin or third parties. | | `fraud-3rd-party` | Account holder is victim of account takeover by unauthorised party. | | `fraud-app-perpetrator` | Account holder is perpetrator receiving fraudulent payments from victims. | | `fraud-app-victim` | Account holder is victim tricked into authorising payments to a fraudulent recipient. | | `law-enforcement` | Restricted following law enforcement request, court order, or legal obligation. | | `money-laundering` | Suspected money laundering detected. Restricted pending investigation. | | `other` | Restriction applied for reasons not covered by standard categories. | | `risk-appetite` | Account activity exceeds risk appetite thresholds. Restricted pending review. | | `sanctions` | Account holder or associated party identified on a sanctions list. Restricted pending investigation. | | `terrorist-financing` | Suspected terrorist financing. Restricted pending investigation. | ### Legal status | Code | Description | |---|---| | `suspected` | Restriction due to suspicion of offence. No formal charges filed. | | `formal-charge-filed` | Customer formally charged with an offence. Legal proceedings active. | | `conviction-confirmed` | Customer convicted. Deposits connected with the conviction are ineligible for FSCS compensation. | | `not-applicable` | Legal status not relevant (e.g. customer requests, dormant accounts). | parameters: - in: body name: request-apply-restriction description: '' required: true schema: type: object properties: restriction-type: type: string enum: - block - freeze restriction-reason-code: type: string enum: - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud-1st-party restriction-legal-status: type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected notes: type: string maxLength: 2000 required: - restriction-type - restriction-reason-code - restriction-legal-status - notes title: request-apply-restriction - type: string required: true name: bank-account-id in: path responses: '201': schema: type: object properties: lift-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: lift-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/lift description: Link to lift a bank account restriction. restriction-status: type: string title: restriction-status x-anyOf: - type: string enum: - lifted - active - type: string restriction-legal-status: type: string title: restriction-legal-status x-anyOf: - type: string enum: - not-applicable - conviction-confirmed - formal-charge-filed - suspected - type: string bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw description: Link to a bank account restriction. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. update-bank-account-restriction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: update-bank-account-restriction-url example: >- /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/actions/update description: Link to update a bank account restriction. bank-account-restriction-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-restriction-id: type: string format: '' title: bank-account-restriction-id required: true name: bank-account-restriction-id required: - bank-account-restriction-id title: bank-account-restriction-events-url example: /v0/bank/account-restrictions/ri.YmFuay1hY2NvdW50LXJlcw/events description: Link to events for a bank account restriction. restriction-reason-code: type: string title: restriction-reason-code x-anyOf: - type: string enum: - suspicious - fraud-app-perpetrator - customer-request - dormant - other - terrorist-financing - law-enforcement - sanctions - risk-appetite - deceased - fraud-app-victim - fraud-3rd-party - money-laundering - fraud - high-risk-pep - fraud-1st-party - type: string restriction-type: type: string title: restriction-type x-anyOf: - type: string enum: - block - freeze - type: string account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. restriction-applied-by: type: object properties: {} required: - restriction-applied-by-type title: restriction-applied-by x-anyOf: - type: object properties: restriction-applied-by-type: enum: - ops-user type: string required: - restriction-applied-by-type - restriction-applied-by-type title: ops-user - type: object properties: restriction-applied-by-type: enum: - user type: string user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. required: - restriction-applied-by-type - user-url - restriction-applied-by-type title: user required: - bank-account-restriction-url - bank-account-restriction-events-url - restriction-status - restriction-applied-by - created-at - account-url title: bank-account-restriction-response description: A bank account restriction. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' '409': description: '' '422': description: '' '500': description: '' summary: Apply bank account restriction /v0/bank/accounts/{bank-account-id}/submissions: get: tags: - Payments description: Lists submissions originating from a bank account parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: filter[submission-status][in][] description: '' type: array required: false x-allOf: - {} - {} items: enum: - scheduled - failed - processing - returned - delivered type: string - in: query name: filter[created-at][lte] description: >- Return only resources with a created-at less than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][lt] description: >- Return only resources with a created-at less than the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gte] description: >- Return only resources with a created-at greater than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gt] description: >- Return only resources with a created-at greater than the given timestamp. type: string required: false format: date-time - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: submissions: type: array items: type: object properties: submission-scheme-information: type: object properties: {} required: - payment-scheme title: submission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. scheme-status-code: type: string minLength: 1 title: scheme-status-code description: >- A scheme-specific code describing the current status. scheme-status-code-description: type: string minLength: 1 title: scheme-status-code-description description: >- A human-readable description of the scheme status code. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer submission-status: title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. scheduled-at: title: scheduled-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. submission-status-reason: title: submission-status-reason type: string minLength: 1 payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. submission-url: type: string title: submission-url example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA required: - submission-status - submission-scheme-information - payment-url - created-at - submission-url - account-url title: submission links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - submissions - links title: submissions-paginated-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List bank account submissions /v0/bank/accounts/{bank-account-id}/transactions: get: tags: - Transactions description: >- Lists transactions on a bank account. Use an `Accept: application/vnd.griffin+xero-csv` header to receive transactions in a CSV format suitable for importing into [Xero](https://central.xero.com/s/article/Import-a-CSV-bank-statement). parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - processed-at - '-processed-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: include description: >- For each transaction returned, include its payment (if one exists) in the response under the `included` attribute. type: string required: false enum: - payment - in: query name: filter[processed-at][lte] description: Return only transactions processed at or before the given timestamp. type: string required: false format: date-time - in: query name: filter[processed-at][lt] description: Return only transactions processed before the given timestamp. type: string required: false format: date-time - in: query name: filter[processed-at][gte] description: Return only transactions processed at or after the given timestamp. type: string required: false format: date-time - in: query name: filter[processed-at][gt] description: Return only transactions processed after the given timestamp. type: string required: false format: date-time - type: string required: true name: bank-account-id in: path responses: '200': schema: type: object properties: account-transactions: type: array items: type: object properties: account-transaction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id title: account-transaction-url description: Link to the transaction resource. example: /v0/bank/transactions/tr.ICB0cmFuc2FjdGlvbi1pZA processed-at: format: date-time type: string description: >- When the transaction was entered into the account ledger. title: processed-at post-datetime: format: date-time type: string description: Deprecated. Please use `processed-at` instead. title: post-datetime balance-change-direction: title: balance-change-direction enum: - credit - debit type: string description: Specifies the direction of a balance change. origin-metadata: type: object additionalProperties: type: string title: origin-metadata description: >- Identifiers from the system that originated the hold or transaction. Keys and values are originator-specific. effective-at: format: date-time type: string description: >- When the transaction actually takes effect on the account balance. title: effective-at transaction-origin-type: title: transaction-origin-type enum: - interest - deposit - manual-payment - card-transaction - fee - transfer - payment - commission type: string description: >- Indicates the source of the transaction. For a description of each origin type, see our guide to [transactions](/docs/guides/transactions). payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. reference: type: string title: reference description: >- This field is provided by the person or entity who made the payment. example: Restaurant Charge - Sushi Palace account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA balance-change: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: balance-change description: >- Shows the account [balance change](/docs/terms/balance-change). account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: >- Shows the [account balance](/docs/terms/account-balance). description: type: string title: description description: >- This field is provided by the bank to help customers understand the nature of the transaction. example: Interest earned in April from Alexa account. required: - account-url - account-transaction-url - account-balance - balance-change - balance-change-direction - transaction-origin-type - processed-at - effective-at title: account-transaction links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links included: title: '' description: Present only when the request uses the `include` parameter. required: - account-transactions - links title: '' description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List transactions /v0/bank/holds/{hold-id}: get: tags: - Bank account holds description: Fetches a single hold by ID. parameters: - type: string required: true name: hold-id in: path responses: '200': schema: type: object properties: expires-at: title: expires-at format: date-time type: string description: ISO 8601 formatted date-time. origin-type: title: origin-type type: string enum: - card-transaction updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. origin-metadata: type: object additionalProperties: type: string title: origin-metadata description: >- Identifiers from the system that originated the hold or transaction. Keys and values are originator-specific. direction: title: direction type: string enum: - debit - credit status: title: status type: string enum: - released - placed created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. release-reason: type: string title: release-reason description: The final release reason (e.g. clearing, expiry, reversal amount: title: amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. hold-url: type: string x-allOf: - type: string - {} - type: object properties: hold-id: type: string format: '' title: hold-id required: true name: hold-id required: - hold-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: hold-id: type: string format: '' title: hold-id required: true name: hold-id required: - hold-id - type: string x-allOf: - type: string - {} - type: object properties: hold-id: type: string format: '' title: hold-id required: true name: hold-id required: - hold-id title: hold-url example: /v0/bank/holds/ho.ICAgICAgICAgaG9sZC1pZA description: Link to this hold. account-transactions: type: array items: type: object properties: account-transaction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id title: account-transaction-url description: Link to the transaction resource. updated-hold-at: format: date-time type: string description: When this account transaction updated the hold. title: updated-hold-at required: - account-transaction-url - updated-hold-at title: account-transaction description: An account transaction associated with this hold. title: account-transactions description: All account transactions associated with this hold. required: - hold-url - account-url - status - amount - direction - created-at - updated-at - origin-type title: hold description: A hold on a bank account. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/bank/products/{bank-product-id}: get: tags: - Bank accounts description: Fetches a bank account product by ID parameters: - type: string required: true name: bank-product-id in: path responses: '200': schema: type: object properties: notice-period: type: object properties: {} required: - notice-period-type title: notice-period description: The notice period of the product. x-anyOf: - type: object properties: notice-period-type: enum: - instant-access type: string title: instant-access required: - notice-period-type - type: object properties: days-of-notice: type: integer format: int64 minimum: 1 title: days-of-notice description: >- The number of days of notice you must give to withdraw funds from a bank account. example: '30' payout-time: type: object properties: local-time: title: local-time format: time type: string description: >- A time of day, comprising hours, minutes and seconds, for example 10:15:30. time-zone: type: string title: time-zone description: A time zone, specified as an IANA TZ identifier example: Europe/London required: - local-time - time-zone title: payout-time description: >- The time of day when funds will be withdrawn from the account and paid to the recipient. notice-period-type: enum: - calendar-days type: string required: - days-of-notice - payout-time - notice-period-type title: calendar-days - type: object properties: cutoff-time: type: object properties: local-time: title: local-time format: time type: string description: >- A time of day, comprising hours, minutes and seconds, for example 10:15:30. time-zone: type: string title: time-zone description: A time zone, specified as an IANA TZ identifier example: Europe/London required: - local-time - time-zone title: cutoff-time description: >- The time of day after which notice will count as having been given on the next working day. payout-time: type: object properties: local-time: title: local-time format: time type: string description: >- A time of day, comprising hours, minutes and seconds, for example 10:15:30. time-zone: type: string title: time-zone description: A time zone, specified as an IANA TZ identifier example: Europe/London required: - local-time - time-zone title: payout-time description: >- The time of day when funds will be withdrawn from the account and paid to the recipient. notice-period-type: enum: - same-or-next-day type: string required: - cutoff-time - payout-time - notice-period-type title: same-or-next-day bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA bank-account-product-status: title: bank-account-product-status type: string enum: - inactive - active commission: type: object properties: gross-rate: type: object properties: basis-points: type: integer format: int64 minimum: 0 display-text: type: string required: - basis-points - display-text title: gross-rate required: - gross-rate title: commission description: The commission rate of the product. bank-account-product-class: title: bank-account-product-class type: string enum: - savings - safeguarding - client-money - operational - embedded display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account product maxLength: 64 example: Operational funding-type: title: funding-type type: string enum: - pooled - dedicated bank-account-product-accounts-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-accounts-url description: >- Link to the [bank accounts](#tag/Bank-accounts) of this product type. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA/accounts updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). interest: type: object properties: annual-effective-rate: type: object properties: basis-points: type: integer format: int64 minimum: 0 display-text: type: string required: - basis-points - display-text title: annual-effective-rate gross-rate: type: object properties: basis-points: type: integer format: int64 minimum: 0 display-text: type: string required: - basis-points - display-text title: gross-rate required: - annual-effective-rate - gross-rate title: interest description: The interest rate of the product. owner-type: title: owner-type type: string enum: - individual - corporation required: - bank-account-product-accounts-url - bank-account-product-class - bank-account-product-status - bank-account-product-url - created-at - display-name - funding-type - notice-period - organization-url - owner-type headers: Location: type: string description: The URL of the bank account product description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get bank account product /v0/bank/products/{bank-product-id}/accounts: post: tags: - Bank accounts description: Opens a bank account of the given bank product parameters: - in: body name: request-open-bank-account description: '' required: true schema: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url title: request-open-bank-account - type: string required: true name: bank-product-id in: path responses: '201': schema: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url description: >- Link to the [payments](#tag/Payments) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account maxLength: 64 example: Reserve a/c controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url description: Link to the events for this bank account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: open-bank-account-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: '' summary: Open bank account with a product /v0/bank/transactions/{transaction-id}: get: tags: - Transactions description: Yields a bank account transaction parameters: - type: string required: true name: transaction-id in: path responses: '200': schema: type: object properties: account-transaction-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-transaction-id: type: string format: '' title: transaction-id required: true name: transaction-id required: - bank-account-transaction-id title: account-transaction-url description: Link to the transaction resource. example: /v0/bank/transactions/tr.ICB0cmFuc2FjdGlvbi1pZA processed-at: format: date-time type: string description: When the transaction was entered into the account ledger. title: processed-at post-datetime: format: date-time type: string description: Deprecated. Please use `processed-at` instead. title: post-datetime balance-change-direction: title: balance-change-direction enum: - credit - debit type: string description: Specifies the direction of a balance change. origin-metadata: type: object additionalProperties: type: string title: origin-metadata description: >- Identifiers from the system that originated the hold or transaction. Keys and values are originator-specific. effective-at: format: date-time type: string description: >- When the transaction actually takes effect on the account balance. title: effective-at transaction-origin-type: title: transaction-origin-type enum: - interest - deposit - manual-payment - card-transaction - fee - transfer - payment - commission type: string description: >- Indicates the source of the transaction. For a description of each origin type, see our guide to [transactions](/docs/guides/transactions). payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. reference: type: string title: reference description: >- This field is provided by the person or entity who made the payment. example: Restaurant Charge - Sushi Palace account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA balance-change: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: balance-change description: >- Shows the account [balance change](/docs/terms/balance-change). account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: Shows the [account balance](/docs/terms/account-balance). description: type: string title: description description: >- This field is provided by the bank to help customers understand the nature of the transaction. example: Interest earned in April from Alexa account. required: - account-url - account-transaction-url - account-balance - balance-change - balance-change-direction - transaction-origin-type - processed-at - effective-at title: account-transaction description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get transaction /v0/claims/{claim-id}: delete: tags: - Claims description: Deletes an existing claim about a Legal Person. parameters: - type: string required: true name: claim-id in: path responses: '204': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/companies-house/companies/{company-number}: get: tags: - Companies House description: >- Lookup Companies House company by company number. Includes information about the company, its directors, and persons with significant control. parameters: - type: string description: UK Companies House company number in: path name: company-number required: true responses: '200': schema: type: object properties: company-address: type: object properties: building-number: title: building-number maxLength: 50 street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB title: company-address date-of-latest-accounts: title: date-of-latest-accounts format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 directors: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity 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 director-appointed-on: title: director-appointed-on format: date type: string description: ISO 8601 formatted date. director-occupation: type: string day-of-birth: type: integer format: int64 minimum: 1 title: day-of-birth example: '1' month-of-birth: type: integer format: int64 minimum: 1 title: month-of-birth example: '1' year-of-birth: type: integer format: int64 minimum: 1 title: year-of-birth example: '1970' required: - display-name - companies-house-url title: ch-director date-of-latest-confirmation-statement: title: date-of-latest-confirmation-statement format: date type: string description: ISO 8601 formatted date. 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: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity 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: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 day-of-birth: type: integer format: int64 minimum: 1 title: day-of-birth example: '1' month-of-birth: type: integer format: int64 minimum: 1 title: month-of-birth example: '1' year-of-birth: type: integer format: int64 minimum: 1 title: year-of-birth example: '1970' required: - display-name - natures-of-control - companies-house-url title: person-with-significant-control confirmation-statement-overdue: type: boolean date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. required: - directors - persons-with-significant-control - date-of-incorporation - corporation-type - entity-registration-number - entity-name - company-status title: company-information-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: '' '429': description: '' '500': description: '' '502': description: '' summary: Lookup company /v0/events/{event-id}: get: tags: - Events summary: Get an event description: | The event-type may be one of: **account-status-created** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "account-status-created", "event-payload" : { "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw", "account-status" : "open" }, "created-at" : "2024-01-01T13:30:00.000Z" } ``` **account-status-updated** ```json { "created-at" : "2024-01-01T17:55:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "account-status-updated", "event-payload" : { "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw", "account-status" : "closed" } } ``` **admission-created** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "admission-created", "event-payload" : { "admission-status" : "processing", "admission-scheme-information" : { "payment-scheme" : "fps", "end-to-end-identification" : "FQ36X73Jb44ZyQE331GYuxLuWM8N85" }, "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ", "created-at" : "2024-01-01T13:20:00.123Z", "admission-url" : "/v0/admissions/pa.oRFnmBymXIKoknlbwroj8g", "unique-scheme-identifier" : "AB123456789123456N1020220426826159900 ", "original-unique-scheme-identifier" : "ZZ123456789123456N1020220426826159900 ", "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA" }, "created-at" : "2024-01-01T13:30:00.000Z" } ``` **admission-updated** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "admission-updated", "event-payload" : { "admission-status" : "delivered", "admission-scheme-information" : { "payment-scheme" : "fps", "end-to-end-identification" : "FQ36X73Jb44ZyQE331GYuxLuWM8N85" }, "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ", "created-at" : "2024-01-01T18:40:00.014Z", "admission-url" : "/v0/admissions/pa.oRFnmBymXIKoknlbwroj8g", "unique-scheme-identifier" : "AB123456789123456N1020220426826159900 ", "original-unique-scheme-identifier" : "ZZ123456789123456N1020220426826159900 ", "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA" }, "created-at" : "2024-01-01T18:45:00.000Z" } ``` **decision-created** ```json { "created-at" : "2020-01-01T00:00:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "decision-created", "event-payload" : { "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA", "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA", "decision-outcome" : "accepted", "decision-maker" : "system", "decision-notes" : "auto-accepted", "created-at" : "1900-01-01T00:00:00.130Z" } } ``` **onboarding-application-created** ```json { "created-at" : "2020-01-01T00:00:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "onboarding-application-created", "event-payload" : { "onboarding-application-url" : "/v0/onboarding/applications/oa.frwOX_PxXnG6PDDp7n6jwQ", "created-at" : "1900-01-01T08:55:12.120Z", "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg", "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA", "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA", "onboarding-application-status" : "processing" } } ``` **onboarding-application-updated** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "onboarding-application-updated", "event-payload" : { "onboarding-application-url" : "/v0/onboarding/applications/oa.frwOX_PxXnG6PDDp7n6jwQ", "created-at" : "2024-02-03T10:00:00.000Z", "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg", "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA", "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA", "decision-outcome" : "accepted", "onboarding-application-status" : "complete" }, "created-at" : "2020-01-01T00:00:00.000Z" } ``` **payment-created** ```json { "created-at" : "2024-01-01T15:45:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "payment-created", "event-payload" : { "creditor" : { "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw", "creditor-type" : "griffin-bank-account" }, "payment-direction" : "inbound-payment", "created-at" : "2024-01-01T15:00:20.237Z", "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ", "payment-reference" : "Dinner", "payment-amount" : { "currency" : "GBP", "value" : "16.00" }, "payment-admissions-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ/admissions", "payment-submissions-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ/submissions", "debtor" : { "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw", "account-holder" : "ZxB7REHskP2ghVt9Lh23I5", "account-number" : "92526719", "account-number-code" : "bban", "bank-id" : "053515", "bank-id-code" : "gbdsc" } } } ``` **submission-created** ```json { "created-at" : "2024-01-01T00:00:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "submission-created", "event-payload" : { "unique-scheme-identifier" : "AB123456789123456N1020220426826159900 ", "submission-status" : "processing", "submission-scheme-information" : { "scheme-status-code-description" : "The payment was accepted by the scheme", "scheme-status-code" : "0000", "end-to-end-identification" : "AHFIWSJFSOK", "payment-scheme" : "fps" }, "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ", "created-at" : "2024-01-01T13:23:01.529Z", "submission-url" : "/v0/submissions/ps.oRFnmBymXIKoknlbwroj8g", "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA" } } ``` **submission-updated** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "submission-updated", "event-payload" : { "unique-scheme-identifier" : "AB123456789123456N1020220426826159900 ", "submission-status" : "delivered", "submission-scheme-information" : { "end-to-end-identification" : "FQ36X73Jb44ZyQE331GYuxLuWM8N85", "payment-scheme" : "fps" }, "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ", "created-at" : "2024-01-01T10:38:32.973Z", "submission-url" : "/v0/submissions/ps.oRFnmBymXIKoknlbwroj8g", "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA" }, "created-at" : "2024-01-01T00:00:00.000Z" } ``` **test-event** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "test-event", "event-payload" : { }, "created-at" : "2020-01-01T00:00:00.000Z" } ``` **transaction-created** ```json { "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "transaction-created", "event-payload" : { "account-transaction-url" : "/v0/bank/transactions/tr.KXXPmz1DVQS-X_HVLlTfWQ", "processed-at" : "2024-01-01T00:00:00.000Z", "post-datetime" : "2024-01-01T00:00:00.000Z", "balance-change-direction" : "debit", "effective-at" : "2024-01-01T00:00:00.000Z", "transaction-origin-type" : "payment", "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ", "reference" : "Dinner", "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw", "balance-change" : { "currency" : "GBP", "value" : "200.00" }, "account-balance" : { "currency" : "GBP", "value" : "800.00" } }, "created-at" : "2024-01-01T00:00:00.000Z" } ``` **verification-created** ```json { "created-at" : "2020-01-01T00:00:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "verification-created", "event-payload" : { "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg", "created-at" : "1900-01-01T00:00:01.063Z", "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA", "verification-status" : "in-progress", "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA", "verification-checks-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA/checks" } } ``` **verification-resource-created** ```json { "created-at" : "2025-02-13T17:15:17.865Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "verification-resource-created", "event-payload" : { "verification-resource-id" : "vr.aVi78djZTiSymFpU-zV60Q", "idv-check-status" : "errored", "idv-check-url" : "TEST", "verification-url" : "/v0/verifications/vn.0khMbqbVSomz4YDdG2YEPQ", "display-name" : "02t1y9jKLQp5CdQ4RsxiEuF7QuNDb177Q1Q9Dp0WSL28gDdia5gW7O8lhA2l9Y8w90B1eV1Q23fly6r20ENNJeR", "legal-person-url" : "/v0/legal-persons/lp.eopIWRwdVVuk6WsW9GzA2w", "idv-check-expires-at" : "2154-10-20", "organization-url" : "/v0/organizations/og.VxGLrVDKSB2e1Ps4TtJKrg", "verification-resource-type" : "idv-check" } } ``` **verification-resource-updated** ```json { "created-at" : "2025-02-13T17:15:17.865Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "verification-resource-updated", "event-payload" : { "verification-resource-id" : "vr.aVi78djZTiSymFpU-zV60Q", "idv-check-status" : "errored", "idv-check-url" : "TEST", "verification-url" : "/v0/verifications/vn.0khMbqbVSomz4YDdG2YEPQ", "display-name" : "02t1y9jKLQp5CdQ4RsxiEuF7QuNDb177Q1Q9Dp0WSL28gDdia5gW7O8lhA2l9Y8w90B1eV1Q23fly6r20ENNJeR", "legal-person-url" : "/v0/legal-persons/lp.eopIWRwdVVuk6WsW9GzA2w", "idv-check-expires-at" : "2154-10-20", "organization-url" : "/v0/organizations/og.VxGLrVDKSB2e1Ps4TtJKrg", "verification-resource-type" : "idv-check" } } ``` **verification-updated** ```json { "created-at" : "2020-01-01T00:00:00.000Z", "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw", "event-type" : "verification-updated", "event-payload" : { "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA", "updated-at" : "1900-01-01T00:03:10.221Z", "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA", "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg", "created-at" : "1900-01-01T00:00:00.408Z", "verification-checks-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA/checks", "risk-rating" : "low-risk", "verification-status" : "checks-complete", "verification-risk-assessments-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA/risk-assessments" } } ``` parameters: - type: string required: true name: event-id in: path responses: '200': description: Fetch an event schema: type: object properties: event-url: type: string title: event-url example: /v0/events/ev.ICAgICAgICBldmVudC1pZA description: Link to the [event](#tag/Events). event-type: title: event-type enum: - onboarding-application-updated - decision-created - payment-created - transaction-created - verification-updated - admission-updated - verification-created - account-status-updated - onboarding-application-created - submission-created - test-event - admission-created - verification-resource-updated - account-status-created - verification-resource-created - submission-updated type: string description: >- The type of webhook event. Usually has the form {resource}-{operation}, e.g. payment-updated event-payload: type: object created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - event-url - event-type - event-payload title: event '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. /v0/legal-persons/{legal-person-id}: get: tags: - Legal persons description: Yields the legal-person. parameters: - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: latest-decision: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: latest-decision description: The most recent [decision](#tag/Decisions) legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. latest-risk-rating-url: type: string title: latest-risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Legal-Person maxLength: 64 example: Company name application-status: title: application-status enum: - referred - errored - declined - submitted - accepted type: string description: Status of the current [application](/docs/terms/application) legal-person-status: title: legal-person-status enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string description: Status of the [legal person](#tag/Legal-persons) legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA legal-person-decisions-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-decisions-url description: >- Link to [decisions](#tag/Decisions) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions status-changed-at: title: status-changed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-claims-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-claims-url description: >- Link to the [claims](#tag/Claims) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims legal-person-bank-payees-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-bank-payees-url description: >- Link to the [payees](#tag/Payees) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees legal-person-verifications-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-verifications-url description: >- Link to all [verifications](#tag/Verifications) run against this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications legal-name: type: string title: legal-name description: A read-only, human readable label derived from claims legal-person-documents-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-documents-url description: >- Link to all evidence documents associated with this [legal person](/docs/terms/legal-person). 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 title: legal-person description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get legal person put: tags: - Legal persons description: Updates the legal-person. parameters: - in: body name: request-update-legal-person description: '' required: true schema: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity required: - display-name title: request-update-legal-person - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: latest-decision: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: latest-decision description: The most recent [decision](#tag/Decisions) legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. latest-risk-rating-url: type: string title: latest-risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Legal-Person maxLength: 64 example: Company name application-status: title: application-status enum: - referred - errored - declined - submitted - accepted type: string description: Status of the current [application](/docs/terms/application) legal-person-status: title: legal-person-status enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string description: Status of the [legal person](#tag/Legal-persons) legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA legal-person-decisions-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-decisions-url description: >- Link to [decisions](#tag/Decisions) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions status-changed-at: title: status-changed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-claims-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-claims-url description: >- Link to the [claims](#tag/Claims) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims legal-person-bank-payees-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-bank-payees-url description: >- Link to the [payees](#tag/Payees) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees legal-person-verifications-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-verifications-url description: >- Link to all [verifications](#tag/Verifications) run against this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications legal-name: type: string title: legal-name description: A read-only, human readable label derived from claims legal-person-documents-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-documents-url description: >- Link to all evidence documents associated with this [legal person](/docs/terms/legal-person). 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 title: legal-person headers: Location: type: string description: The location of the updated legal-person of type individual description: '' '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: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: '' summary: Update legal person /v0/legal-persons/{legal-person-id}/bank/payees: get: tags: - Payees description: Lists payees belonging to the legal person. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - in: query name: include description: >- For each payee returned, include its Confirmation of Payee (CoP) details (if they exist) in the response under the `included` attribute. type: array required: false x-allOf: - {} - {} items: enum: - cop-requests type: string - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: payees: type: array items: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). payee-url: type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id title: payee-url example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA description: Link to the [payee](#tag/Payees). account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. payee-status: title: payee-status enum: - deactivated - active type: string description: >- The status of the payee; you can only make payments to active payees. country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB required: - account-holder - account-number - bank-id - country-code - created-at - legal-person-url - payee-status - payee-url title: payee links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links included: title: '' description: Present only when the request uses the `include` parameter. required: - links - payees title: '' description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List legal person payees post: tags: - Payees description: >- Registers a new payee with a legal person. You may associate the outcome of a [CoP request](#tag/Confirmation-of-payee) with the payee by supplying a `cop-request-url`. parameters: - in: body name: request-create-bank-payee description: '' required: true schema: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: The name of the [account holder](/docs/terms/account-holder). account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). required: - account-holder - account-number - bank-id title: request-create-bank-payee - type: string required: true name: legal-person-id in: path responses: '201': schema: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). payee-url: type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id title: payee-url example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA description: Link to the [payee](#tag/Payees). account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 account-holder: type: string minLength: 1 title: account-holder description: The name of the [account holder](/docs/terms/account-holder). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. payee-status: title: payee-status enum: - deactivated - active type: string description: >- The status of the payee; you can only make payments to active payees. country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB required: - account-holder - account-number - bank-id - country-code - created-at - legal-person-url - payee-status - payee-url title: payee description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '409': description: '' '422': description: '' summary: Create payee /v0/legal-persons/{legal-person-id}/claims: get: tags: - Claims description: Yields a list of all current claims about this Legal Person. parameters: - in: query name: filter[verification-status][eq] description: >- The verification-status of a claim changes from `"unverified"` to `"verified"` when it has successfully been used in a verification as part of an accepted application. Claims of errored or declined applications are `"unverified"`. type: string required: false enum: - unverified - verified - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - alternative-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - telephone-number - claim-type title: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-address - claim-type title: business-address - type: object properties: business-description: title: business-description type: string minLength: 1 claim-type: enum: - business-description type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-description - claim-type title: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - email-address - claim-type title: company-email-address - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - company-telephone-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - telephone-number - claim-type title: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - email-address - claim-type title: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). claim-type: enum: - entity-address type: string city: title: city minLength: 1 maxLength: 50 address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. address-line-2: title: address-line-2 description: Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - individual-sources-of-funds type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - individual-sources-of-funds - claim-type title: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - managed-property-count - claim-type title: managed-properties - type: object properties: mobile-number: title: mobile-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - mobile-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - mobile-number - claim-type title: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - nationality - claim-type title: nationality - type: object properties: nfe-classification: title: nfe-classification type: string enum: - passive-nfe - active-nfe claim-type: enum: - nfe-classification type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - nfe-classification - claim-type title: nfe-classification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - ownership-percent - claim-type x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - property-types - claim-type title: property-types - 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - purposes-of-account - claim-type title: purposes-of-account - 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - reliance-verification-methods - reliance-verification-standard - claim-type title: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type title: senior-manager-function-holder - 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - sic-codes - claim-type title: sic-codes - type: object properties: social-media: title: social-media type: string minLength: 1 claim-type: enum: - social-media type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - social-media - claim-type title: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - sources-of-funds - claim-type title: sources-of-funds - type: object properties: tax-identification-number: title: tax-identification-number type: string minLength: 1 claim-type: enum: - tax-identification-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tax-identification-number - claim-type title: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - trading-name - claim-type title: trading-name - type: object properties: claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - uk-company-register type: string entity-name: title: entity-name 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - uk-regulatory-permissions - claim-type title: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - claims - links title: legal-person-claims-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List claims post: tags: - Claims description: Creates a new claim about a Legal Person. parameters: - in: body name: claim description: '' required: true schema: type: object properties: {} required: - claim-type x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: |- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account title: claim - type: string required: true name: legal-person-id in: path responses: '201': schema: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - alternative-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - telephone-number - claim-type title: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-address - claim-type title: business-address - type: object properties: business-description: title: business-description type: string minLength: 1 claim-type: enum: - business-description type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-description - claim-type title: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: |- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - email-address - claim-type title: company-email-address - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - company-telephone-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - telephone-number - claim-type title: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - email-address - claim-type title: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). claim-type: enum: - entity-address type: string city: title: city minLength: 1 maxLength: 50 address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. address-line-2: title: address-line-2 description: Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - individual-sources-of-funds type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - individual-sources-of-funds - claim-type title: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - managed-property-count - claim-type title: managed-properties - type: object properties: mobile-number: title: mobile-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - mobile-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - mobile-number - claim-type title: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - nationality - claim-type title: nationality - type: object properties: nfe-classification: title: nfe-classification type: string enum: - passive-nfe - active-nfe claim-type: enum: - nfe-classification type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - nfe-classification - claim-type title: nfe-classification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - ownership-percent - claim-type x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - property-types - claim-type title: property-types - 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - purposes-of-account - claim-type title: purposes-of-account - 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - reliance-verification-methods - reliance-verification-standard - claim-type title: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - legal-person-url - claim-type title: senior-manager-function-holder - 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - sic-codes - claim-type title: sic-codes - type: object properties: social-media: title: social-media type: string minLength: 1 claim-type: enum: - social-media type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - social-media - claim-type title: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - sources-of-funds - claim-type title: sources-of-funds - type: object properties: tax-identification-number: title: tax-identification-number type: string minLength: 1 claim-type: enum: - tax-identification-number type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tax-identification-number - claim-type title: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - trading-name - claim-type title: trading-name - type: object properties: claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - uk-company-register type: string entity-name: title: entity-name 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - uk-regulatory-permissions - claim-type title: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. claim-url: type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id - type: string x-allOf: - type: string - {} - type: object properties: claim-id: type: string format: '' title: claim-id required: true name: claim-id required: - claim-id title: claim-url example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA description: Link to the [claim](#tag/Claims). required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account description: '' '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: type: string description: Returns `GriffinSession` if no valid authentication is found. '422': description: '' summary: Create claim /v0/legal-persons/{legal-person-id}/decisions: get: tags: - Decisions description: Lists all decisions for the given legal-person. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: decisions: type: array items: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: decision links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - decisions - links title: decisions-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List decisions post: tags: - Decisions 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: - in: body name: request-create-decision description: '' required: true schema: type: object properties: verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: Free-text field to explain the reasons behind the decision. required: - verification-url - decision-outcome - decision-notes title: request-create-decision - type: string required: true name: legal-person-id in: path responses: '201': schema: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: decision description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' '422': description: '' '500': description: '' '503': description: '' summary: Create decision /v0/legal-persons/{legal-person-id}/history: get: tags: - Legal person history description: Lists history of events for the given legal person. parameters: - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: legal-person-history: type: array items: type: object properties: {} required: - legal-person-history-event-type title: history event x-anyOf: - type: object properties: legal-person-history-event-type: enum: - risk-rating-registered type: string timestamp: format: date-time type: string description: Date time of this event. title: timestamp risk-rating: title: risk-rating type: string enum: - high-risk - prohibited-risk - medium-risk - low-risk notes: type: string minLength: 1 title: notes description: Rationale for overriding the risk rating. manually-created-by: type: object properties: {} required: - manually-created-by-type title: manually-created-by description: User that triggered this event. x-anyOf: - type: object properties: manually-created-by-type: enum: - ops-user type: string required: - manually-created-by-type - manually-created-by-type title: ops-user 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: risk-rating-registered - type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-history-event-type: title: legal-person-history-event-type type: string enum: - risk-rating-registered - decision-created - verification-created timestamp: format: date-time type: string description: Date time of this event. title: timestamp decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-history-event-type - timestamp - verification-url - decision-outcome - decision-maker - decision-notes - legal-person-history-event-type title: decision-created - type: object properties: legal-person-history-event-type: enum: - verification-created type: string timestamp: format: date-time type: string description: Date time of this event. title: timestamp verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). required: - legal-person-history-event-type - timestamp - verification-url - workflow-url - legal-person-history-event-type title: verification-created links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta required: - legal-person-history - links title: legal-person-history-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/legal-persons/{legal-person-id}/verifications: get: tags: - Verifications description: List verifications for the given legal person. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: legal-person-id in: path responses: '200': schema: type: object properties: verifications: type: array items: type: object properties: verification-profiles-url: type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id title: verification-profiles-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/profiles description: >- Get claims used in this [verification](#tag/Verifications) for all associated [legal persons](/docs/terms/legal-person). verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). verification-resources-url: type: string title: verification-resources-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/resources description: >- A link to the resources of a [verification](#tag/Verifications). updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. verification-checks-url: type: string title: verification-checks-url 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: type: string title: verification-risk-assessments-url required: - created-at - legal-person-url - verification-status - verification-url - verification-checks-url title: verification links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta required: - verifications - links title: verifications-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List verifications for a legal person post: tags: - Verifications 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](#tag/Workflows/paths/~1v0~1workflows~1{workflow-id}/get). --- 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: - in: body name: request-create-verification description: '' required: true schema: type: object properties: workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). required: - workflow-url title: request-create-verification - type: string required: true name: legal-person-id in: path responses: '201': schema: type: object properties: verification-profiles-url: type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id title: verification-profiles-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/profiles description: >- Get claims used in this [verification](#tag/Verifications) for all associated [legal persons](/docs/terms/legal-person). verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). verification-resources-url: type: string title: verification-resources-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/resources description: >- A link to the resources of a [verification](#tag/Verifications). updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. verification-checks-url: type: string title: verification-checks-url 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: type: string title: verification-risk-assessments-url required: - created-at - legal-person-url - verification-status - verification-url - verification-checks-url title: verification headers: Location: type: string description: The URL of the verification description: The created verification '400': description: 'Bad Request: specific error details will be provided, if available' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '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' summary: Perform verification of a legal person /v0/memberships/{membership-id}: get: tags: - Memberships description: >- Returns the [user's](#tag/Users) [membership](#tag/Memberships) information. parameters: - type: string required: true name: membership-id in: path responses: '200': schema: type: object properties: membership-url: type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id title: membership-url example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA description: Link to the [membership](#tag/Memberships). membership-roles-url: type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id title: membership-roles-url example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles description: >- Link to the assigned [roles](#tag/Roles) for this [membership](#tag/Memberships). organization: type: object properties: own-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: own-legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [organization](#tag/Organizations); this can be an individual or a company. organization-mode: title: organization-mode enum: - test-mode - live-mode type: string description: >- The organization can either be a sandbox organization or a live one; Check out our guide for [sandbox mode vs live mode](/docs/guides/sandbox-vs-live-mode). organization-memberships-url: type: string title: organization-memberships-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships description: >- Link to the [memberships](#tag/Memberships) for this [organization](#tag/Organizations). organization-invitations-url: type: string title: organization-invitations-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations description: >- Link to the resource that enables you to [invite](#tag/Invites) new [users](#tag/Users) to this [organization](#tag/Organizations). organization-payments-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments description: >- Link to the [payments](#tag/Payments) associated with this organization. organization-bank-account-products-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-account-products-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/products description: >- Link to the [bank account](#tag/Bank-accounts) products owned by this [organization](#tag/Organization). organization-onboarding-applications-url: type: string title: organization-onboarding-applications-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications description: >- Link to the [Reliance onboarding](#tag/Reliance-onboarding). display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity organization-bank-accounts-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-accounts-search-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/search description: >- Link to search [bank accounts](#tag/Bank-accounts) associated with this [organization](#tag/Organizations). organization-api-keys-url: type: string title: organization-api-keys-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys organization-live-access-url: type: string title: organization-live-access-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access description: >- Link to the resource that enables you to request live access. organization-webhooks-url: type: string title: organization-webhooks-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks description: Link to the endpoint which enables webhook creation. organization-workflows-url: type: string title: organization-workflows-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows description: >- Link to the onboarding [workflows](#tag/Workflows) configured for this [organization](#tag/Organizations). organization-bank-accounts-url: type: string title: organization-bank-accounts-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts description: >- Link to the [bank accounts](#tag/Bank-accounts) managed by this [organization](#tag/Organizations). available-roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). role-category: type: string required: - display-name - description - role-url title: role description: >- The subset of [roles](#tag/Roles) available to [members](#tag/Members) of this [organization](#tag/Organizations). title: available-roles can-decide-on-verifications?: type: boolean title: can-decide-on-verifications? description: >- Is this organization able to make manual decisions on verifications? organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). organization-payments-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-search-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments/search description: >- Link to search [payments](#tag/Payments) associated with this organization. organization-individuals-url: type: string title: organization-individuals-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals organization-corporations-url: type: string title: organization-corporations-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations organization-legal-persons-url: type: string title: organization-legal-persons-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons description: >- Link to the [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-legal-persons-search-url: type: string title: organization-legal-persons-search-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons/search description: >- Link to search [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-events-url: type: string title: organization-events-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events description: Link to the endpoint which lists an organization's events. required: - available-roles - can-decide-on-verifications? - display-name - organization-api-keys-url - organization-bank-accounts-url - organization-bank-account-products-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-payments-url - organization-url - organization-webhooks-url - organization-workflows-url - own-legal-person-url - organization-legal-persons-search-url - organization-bank-accounts-search-url - organization-payments-search-url title: organization description: Shows the associated [organization](#tag/Organizations). roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). role-category: type: string required: - display-name - description - role-url title: role title: roles description: Shows a collection of [roles](#tag/Roles). user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: user description: Shows the associated [user](#tag/Users). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - membership-url - membership-roles-url - organization - roles - user - created-at title: membership description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get membership delete: tags: - Memberships description: Removes a [user](#tag/Users) from an [organization](#tag/Organizations). parameters: - type: string required: true name: membership-id in: path responses: '204': description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Delete membership /v0/memberships/{membership-id}/roles: get: tags: - Roles description: >- Returns the [roles](#tag/Roles) assigned to this [membership](#tag/Memberships). parameters: - type: string required: true name: membership-id in: path responses: '200': schema: type: object properties: roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). role-category: type: string required: - display-name - description - role-url title: role title: roles description: Shows a collection of [roles](#tag/Roles). required: - roles title: roles-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List membership roles put: tags: - Roles description: >- Assigns [roles](#tag/Roles) to the [membership](#tag/Memberships). A 422 Unprocessable Entity is served if either: * one role url provided in the body is not in the [Organisations](#tag/Organizations) `"available-roles"` * the request attempts to remove the last admin role of the organization, thus making the organisation unusable. parameters: - in: body name: request-update-membership-roles description: '' required: true schema: type: object properties: role-urls: type: array items: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). required: - role-urls title: request-update-membership-roles - type: string required: true name: membership-id in: path responses: '200': schema: type: object properties: roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). role-category: type: string required: - display-name - description - role-url title: role title: roles description: Shows a collection of [roles](#tag/Roles). required: - roles title: roles-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: >- Unprocessable Entity is served if either: * one role url provided in the body is not in the [Organisations](#tag/Organizations) `"available-roles"` * the request attempts to remove the last admin role of the organization, thus making the organisation unusable. summary: Update role /v0/onboarding/applications/{onboarding-application-id}: get: tags: - Reliance onboarding description: Fetch an onboarding application. parameters: - type: string required: true name: onboarding-application-id in: path responses: '200': schema: type: object properties: {} required: - onboarding-application-status title: onboarding-application x-anyOf: - type: object properties: onboarding-application-url: type: string title: onboarding-application-url example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ description: Link to the onboarding application. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). onboarding-application-status: enum: - processing type: string required: - created-at - legal-person-url - onboarding-application-url - verification-url - workflow-url - onboarding-application-status title: processing - type: object properties: onboarding-application-url: type: string title: onboarding-application-url example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ description: Link to the onboarding application. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). onboarding-application-status: enum: - submitted type: string required: - created-at - onboarding-application-url - workflow-url - onboarding-application-status title: submitted - type: object properties: onboarding-application-url: type: string title: onboarding-application-url example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ description: Link to the onboarding application. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). error-reasons: type: array items: type: string onboarding-application-status: enum: - errored type: string required: - created-at - legal-person-url - onboarding-application-url - verification-url - workflow-url - onboarding-application-status title: errored - type: object properties: onboarding-application-url: type: string title: onboarding-application-url example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ description: Link to the onboarding application. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). 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 title: complete description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get onboarding application /v0/open-banking/tell-consents/{consent-id}: get: tags: - Open banking description: Fetch a registered Tell consent. parameters: - type: string in: path name: consent-id required: true responses: '200': schema: type: object properties: tell-consent-expiry: title: tell-consent-expiry format: date-time type: string description: ISO 8601 formatted date-time. tell-gateway-id: type: string format: uuid title: tell-gateway-id created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. tell-consent-id: type: string format: uuid title: tell-consent-id tell-consent-scope: type: string title: tell-consent-scope x-anyOf: - type: string enum: - payments - accounts - type: string tell-consent-consumed-at: title: tell-consent-consumed-at format: date-time type: string description: ISO 8601 formatted date-time. tell-consent-url: type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id - type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id title: tell-consent-url example: >- /v0/open-banking/tell-consents/00000000-0000-0000-0000-000000000000 tell-consent-status: type: string title: tell-consent-status x-anyOf: - type: string enum: - revoked - consumed - authorised - type: string tell-consent-permissions: type: array items: type: string title: tell-consent-permission x-anyOf: - type: string enum: - ReadPartyPSU - ReadTransactionsDetail - ReadProducts - ReadStatementsDetail - ReadDirectDebits - ReadTransactionsDebits - ReadTransactionsCredits - ReadBeneficiariesDetail - ReadBalances - ReadPAN - ReadScheduledPaymentsDetail - ReadAccountsDetail - ReadAccountsBasic - ReadOffers - ReadBeneficiariesBasic - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadTransactionsBasic - ReadParty - ReadStatementsBasic - ReadScheduledPaymentsBasic - type: string bank-account-urls: type: array items: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. tell-consent-revoked-at: title: tell-consent-revoked-at format: date-time type: string description: ISO 8601 formatted date-time. required: - tell-consent-url - tell-consent-id - tell-gateway-id - bank-account-urls - tell-consent-scope - tell-consent-permissions - tell-consent-status - created-at title: tell-consent-response description: A registered Tell consent. description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get Tell consent /v0/open-banking/tell-consents/{consent-id}/actions/revoke: post: tags: - Open banking description: |- Revoke a registered Tell consent. After revoking a consent with Tell Money, also revoke it with Griffin so that Griffin rejects any further resource requests for this consent. parameters: - type: string in: path name: consent-id required: true responses: '200': schema: type: object properties: tell-consent-expiry: title: tell-consent-expiry format: date-time type: string description: ISO 8601 formatted date-time. tell-gateway-id: type: string format: uuid title: tell-gateway-id created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. tell-consent-id: type: string format: uuid title: tell-consent-id tell-consent-scope: type: string title: tell-consent-scope x-anyOf: - type: string enum: - payments - accounts - type: string tell-consent-consumed-at: title: tell-consent-consumed-at format: date-time type: string description: ISO 8601 formatted date-time. tell-consent-url: type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id - type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id title: tell-consent-url example: >- /v0/open-banking/tell-consents/00000000-0000-0000-0000-000000000000 tell-consent-status: type: string title: tell-consent-status x-anyOf: - type: string enum: - revoked - consumed - authorised - type: string tell-consent-permissions: type: array items: type: string title: tell-consent-permission x-anyOf: - type: string enum: - ReadPartyPSU - ReadTransactionsDetail - ReadProducts - ReadStatementsDetail - ReadDirectDebits - ReadTransactionsDebits - ReadTransactionsCredits - ReadBeneficiariesDetail - ReadBalances - ReadPAN - ReadScheduledPaymentsDetail - ReadAccountsDetail - ReadAccountsBasic - ReadOffers - ReadBeneficiariesBasic - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadTransactionsBasic - ReadParty - ReadStatementsBasic - ReadScheduledPaymentsBasic - type: string bank-account-urls: type: array items: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. tell-consent-revoked-at: title: tell-consent-revoked-at format: date-time type: string description: ISO 8601 formatted date-time. required: - tell-consent-url - tell-consent-id - tell-gateway-id - bank-account-urls - tell-consent-scope - tell-consent-permissions - tell-consent-status - created-at title: tell-consent-response description: A registered Tell consent. description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: Consent not found. '422': description: Consent is already revoked. summary: Revoke Tell consent /v0/organizations/{organization-id}: get: tags: - Organizations description: Yields the organization details parameters: - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: own-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: own-legal-person-url description: >- Link to the [legal person](#tag/Legal-persons) that represents the [organization](#tag/Organizations); this can be an individual or a company. example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA organization-mode: title: organization-mode enum: - test-mode - live-mode type: string description: >- The organization can either be a sandbox organization or a live one; Check out our guide for [sandbox mode vs live mode](/docs/guides/sandbox-vs-live-mode). organization-memberships-url: type: string title: organization-memberships-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships description: >- Link to the [memberships](#tag/Memberships) for this [organization](#tag/Organizations). organization-invitations-url: type: string title: organization-invitations-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations description: >- Link to the resource that enables you to [invite](#tag/Invites) new [users](#tag/Users) to this [organization](#tag/Organizations). organization-payments-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-url description: >- Link to the [payments](#tag/Payments) associated with this organization. example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments organization-bank-account-products-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-account-products-url description: >- Link to the [bank account](#tag/Bank-accounts) products owned by this [organization](#tag/Organization). example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/products organization-onboarding-applications-url: type: string title: organization-onboarding-applications-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications description: Link to the [Reliance onboarding](#tag/Reliance-onboarding). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org organization-bank-accounts-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-accounts-search-url description: >- Link to search [bank accounts](#tag/Bank-accounts) associated with this [organization](#tag/Organizations). example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/search organization-api-keys-url: type: string title: organization-api-keys-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys organization-live-access-url: type: string title: organization-live-access-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access description: Link to the resource that enables you to request live access. organization-webhooks-url: type: string title: organization-webhooks-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks description: Link to the endpoint which enables webhook creation. organization-workflows-url: type: string title: organization-workflows-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows description: >- Link to the onboarding [workflows](#tag/Workflows) configured for this [organization](#tag/Organizations). organization-bank-accounts-url: type: string title: organization-bank-accounts-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts description: >- Link to the [bank accounts](#tag/Bank-accounts) managed by this [organization](#tag/Organizations). available-roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url description: Link to the [role](#tag/Roles). example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA role-category: type: string required: - display-name - description - role-url title: role description: >- The subset of [roles](#tag/Roles) available to [members](#tag/Members) of this [organization](#tag/Organizations). title: available-roles organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). organization-payments-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-search-url description: >- Link to search [payments](#tag/Payments) associated with this organization. example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments/search organization-individuals-url: type: string title: organization-individuals-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals organization-corporations-url: type: string title: organization-corporations-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations organization-legal-persons-url: type: string title: organization-legal-persons-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons description: >- Link to the [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-legal-persons-search-url: type: string title: organization-legal-persons-search-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons/search description: >- Link to search [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-events-url: type: string title: organization-events-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events description: Link to the endpoint which lists an organization's events. required: - available-roles - can-decide-on-verifications? - display-name - organization-api-keys-url - organization-bank-accounts-url - organization-bank-account-products-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-payments-url - organization-url - organization-webhooks-url - organization-workflows-url - own-legal-person-url - organization-legal-persons-search-url - organization-bank-accounts-search-url - organization-payments-search-url title: organization additionalProperties: false headers: Location: type: string description: The URL of the organization description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get organization /v0/organizations/{organization-id}/api-keys: get: tags: - API keys description: List all active API keys in your organization. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: api-keys: type: array items: type: object properties: api-key-url: type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id title: api-key-url description: The resource path for the API key example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA api-key-name: title: api-key-name pattern: ^[a-zA-z0-9-_]+ description: The immutable display name for the API key maxLength: 64 example: buildserver minLength: 1 api-key-live?: type: boolean organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - api-key-url - api-key-name - api-key-live? - organization-url - user-url - created-at title: api-key links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links included: title: '' description: Present only when the request uses the `include` parameter. required: - api-keys - links title: organization-api-keys-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List API keys post: tags: - API keys description: Create a new API key. This is the only time `api-key-secret` is shown. parameters: - in: body name: request-create-api-key description: '' required: true schema: 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 title: request-create-api-key - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: api-key-url: type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id title: api-key-url description: The resource path for the API key example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA api-key-name: title: api-key-name pattern: ^[a-zA-z0-9-_]+ description: The immutable display name for the API key maxLength: 64 example: buildserver minLength: 1 api-key-live?: type: boolean organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. api-key-secret: type: string title: api-key-secret description: The API secret example: g-test-buildserver-RrUZ5fUG4pSKwYVVG1C3Ft1xrMRxy1T7KUIyTva5bTk required: - api-key-live? - api-key-name - api-key-secret - api-key-url - created-at - organization-url - user-url headers: Location: type: string description: The URL of the created API key description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '409': description: '' summary: Create API Key /v0/organizations/{organization-id}/bank/accounts: get: tags: - Bank accounts description: >- Yields a list of all bank accounts under the control of this Organization. parameters: - in: query name: filter[account-restricted][eq] description: >- Specifies whether the bank account has restrictions applied by Griffin. type: boolean required: false - description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. name: filter[beneficiary-url][eq] type: string x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id required: false in: query - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: include description: >- For each bank account returned, include its owner and/or beneficiary in the response under the `included.legal-persons` attribute. type: array required: false x-allOf: - {} - {} items: type: string enum: - beneficiary - owner - in: query name: filter[account-status][in][] description: '' type: array required: false x-allOf: - {} - {} items: enum: - closing - open - closed - opening type: string - in: query name: sort description: '' type: string required: false enum: - '-created-at' - display-name - created-at - '-display-name' - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: filter[pooled-funds][eq] description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. type: boolean required: false - in: query name: filter[bank-product-type][in][] description: '' type: array required: false x-allOf: - {} - {} items: enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string - description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. name: filter[owner-url][eq] type: string x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id required: false in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: accounts: type: array items: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url description: >- Link to the [payments](#tag/Payments) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account maxLength: 64 example: Reserve a/c controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: >- Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: >- Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url description: Link to the events for this bank account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: >- Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links included: title: '' description: Present only when the request uses the `include` parameter. required: - accounts - links title: '' description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List bank accounts post: tags: - Bank accounts description: Open a new bank account parameters: - in: body name: request-open-bank-account description: '' required: true schema: type: object properties: {} required: - bank-product-type x-anyOf: - type: object properties: bank-product-type: enum: - savings-account type: string required: - savings-type - bank-product-type x-anyOf: - type: object properties: owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity savings-type: enum: - easy-access type: string required: - owner-url - savings-type title: easy-access - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity savings-type: enum: - bare-trust type: string title: bare-trust required: - savings-type title: savings-account - type: object properties: bank-product-type: enum: - client-money-account type: string required: - pooled-funds - bank-product-type x-anyOf: - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url pooled-funds: enum: - true type: string x-allOf: - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url - {} title: 'true' required: - pooled-funds - type: object properties: beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url pooled-funds: enum: - false type: string required: - beneficiary-url - pooled-funds x-allOf: - type: object properties: beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url required: - beneficiary-url - {} title: 'false' title: client-money-account - type: object properties: bank-product-type: enum: - safeguarding-account type: string required: - pooled-funds - bank-product-type x-anyOf: - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url pooled-funds: enum: - true type: string x-allOf: - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url - {} title: 'true' required: - pooled-funds - type: object properties: beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url pooled-funds: enum: - false type: string required: - beneficiary-url - pooled-funds x-allOf: - type: object properties: beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url required: - beneficiary-url - {} title: 'false' title: safeguarding-account - type: object properties: owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity bank-product-type: enum: - embedded-account type: string required: - owner-url - bank-product-type title: embedded-account - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity bank-product-type: enum: - operational-account type: string title: operational-account required: - bank-product-type title: request-open-bank-account - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url description: >- Link to the [payments](#tag/Payments) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account maxLength: 64 example: Reserve a/c controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url description: Link to the bank account resource. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url description: Link to the events for this bank account. example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account headers: Location: type: string description: The URL of the created bank account description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: '' summary: Open bank account deprecated: true /v0/organizations/{organization-id}/bank/accounts/search: post: tags: - Bank accounts description: >- Returns a list of bank accounts whose account number match the `search-query` supplied in the request, either exactly or partially as a prefix. parameters: - in: body name: bank-accounts-search description: '' required: true schema: type: object properties: search-query: title: search-query type: string minLength: 1 required: - search-query title: bank-accounts-search - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: search-results: type: array items: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA description: Link to the [bank account](#tag/Bank-accounts) product. account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments description: >- Link to the [payments](#tag/Payments) associated with this account. pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: >- Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: >- Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events description: Link to the events for this bank account. beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: >- Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta required: - search-results - meta title: bank-accounts-search-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Search bank accounts /v0/organizations/{organization-id}/bank/products: get: tags: - Bank accounts description: Returns a paginated list of the organization's bank account products. parameters: - in: query name: filter[status][in][] description: '' type: array required: false x-allOf: - {} - {} items: type: string enum: - inactive - active - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: bank-account-products: type: array items: type: object properties: notice-period: type: object properties: {} required: - notice-period-type title: notice-period description: The notice period of the product. x-anyOf: - type: object properties: notice-period-type: enum: - instant-access type: string title: instant-access required: - notice-period-type - type: object properties: days-of-notice: type: integer format: int64 minimum: 1 title: days-of-notice description: >- The number of days of notice you must give to withdraw funds from a bank account. example: '30' payout-time: type: object properties: local-time: title: local-time format: time type: string description: >- A time of day, comprising hours, minutes and seconds, for example 10:15:30. time-zone: type: string title: time-zone description: >- A time zone, specified as an IANA TZ identifier example: Europe/London required: - local-time - time-zone title: payout-time description: >- The time of day when funds will be withdrawn from the account and paid to the recipient. notice-period-type: enum: - calendar-days type: string required: - days-of-notice - payout-time - notice-period-type title: calendar-days - type: object properties: cutoff-time: type: object properties: local-time: title: local-time format: time type: string description: >- A time of day, comprising hours, minutes and seconds, for example 10:15:30. time-zone: type: string title: time-zone description: >- A time zone, specified as an IANA TZ identifier example: Europe/London required: - local-time - time-zone title: cutoff-time description: >- The time of day after which notice will count as having been given on the next working day. payout-time: type: object properties: local-time: title: local-time format: time type: string description: >- A time of day, comprising hours, minutes and seconds, for example 10:15:30. time-zone: type: string title: time-zone description: >- A time zone, specified as an IANA TZ identifier example: Europe/London required: - local-time - time-zone title: payout-time description: >- The time of day when funds will be withdrawn from the account and paid to the recipient. notice-period-type: enum: - same-or-next-day type: string required: - cutoff-time - payout-time - notice-period-type title: same-or-next-day bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url description: Link to the [bank account](#tag/Bank-accounts) product. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA bank-account-product-status: title: bank-account-product-status type: string enum: - inactive - active commission: type: object properties: gross-rate: type: object properties: basis-points: type: integer format: int64 minimum: 0 display-text: type: string required: - basis-points - display-text title: gross-rate required: - gross-rate title: commission description: The commission rate of the product. bank-account-product-class: title: bank-account-product-class type: string enum: - savings - safeguarding - client-money - operational - embedded display-name: type: string minLength: 1 title: display-name description: The mutable display name for the bank account product maxLength: 64 example: Operational funding-type: title: funding-type type: string enum: - pooled - dedicated bank-account-product-accounts-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-accounts-url description: >- Link to the [bank accounts](#tag/Bank-accounts) of this product type. example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA/accounts updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). interest: type: object properties: annual-effective-rate: type: object properties: basis-points: type: integer format: int64 minimum: 0 display-text: type: string required: - basis-points - display-text title: annual-effective-rate gross-rate: type: object properties: basis-points: type: integer format: int64 minimum: 0 display-text: type: string required: - basis-points - display-text title: gross-rate required: - annual-effective-rate - gross-rate title: interest description: The interest rate of the product. owner-type: title: owner-type type: string enum: - individual - corporation required: - bank-account-product-accounts-url - bank-account-product-class - bank-account-product-status - bank-account-product-url - created-at - display-name - funding-type - notice-period - organization-url - owner-type links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta required: - bank-account-products - links title: '' description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List bank account products /v0/organizations/{organization-id}/cop-request: post: tags: - Confirmation of payee description: Create a Confirmation of Payee (CoP) request. parameters: - in: body name: create-cop-request description: '' required: true schema: type: object properties: account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-classification: title: account-classification type: string enum: - personal - business name: title: name description: The name of the payee. example: John Smith requester-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: requester-legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). secondary-reference-data: title: secondary-reference-data description: >- Secondary reference data, such as a building society roll number or a credit card number. example: '1234567890' required: - account-number - bank-id - account-classification - name - requester-legal-person-url title: create-cop-request - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). account: type: object properties: account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-classification: title: account-classification type: string enum: - personal - business name: title: name description: The name of the payee. example: John Smith requester-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: requester-legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). secondary-reference-data: title: secondary-reference-data description: >- Secondary reference data, such as a building society roll number or a credit card number. example: '1234567890' required: - account-number - bank-id - account-classification - name - requester-legal-person-url title: account description: The payee's account details. cop-response: type: object properties: status: title: status type: string enum: - verified - unverified result: title: result type: string enum: - match - close-match - no-match reason: title: reason type: string enum: - no-match-name - account-not-supported - match-name-business-personal - match-name-personal-business - close-match-name-business-personal - no-match-secondary-ref - close-match-name - account-switched - close-match-name-personal-business suggested-name: type: string title: suggested-name description: >- The suggested name of the payee. Only present on a close match. suggested-account-classification: title: suggested-account-classification enum: - personal - business type: string description: >- The suggested account classification. Only present on a close match. example: business required: - status - result title: cop-response description: The outcome of the CoP request required: - cop-request-url - account - cop-response title: cop-request description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '409': description: '' '422': description: '' summary: Create a CoP request /v0/organizations/{organization-id}/events: get: tags: - Events description: List all events for an organization parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: filter[event-type][eq] description: >- The type of webhook event. Usually has the form {resource}-{operation}, e.g. payment-updated type: string required: false enum: - onboarding-application-updated - decision-created - payment-created - transaction-created - verification-updated - admission-updated - verification-created - account-status-updated - onboarding-application-created - submission-created - test-event - admission-created - verification-resource-updated - account-status-created - verification-resource-created - submission-updated - in: query name: filter[created-at][lte] description: >- Return only events with a created-at less than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][lt] description: Return only events with a created-at less than the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gte] description: >- Return only events with a created-at greater than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gt] description: >- Return only events with a created-at greater than the given timestamp. type: string required: false format: date-time - type: string required: true name: organization-id in: path responses: '200': description: Fetch all organization events schema: type: object properties: events: type: array items: type: object properties: event-url: type: string title: event-url example: /v0/events/ev.ICAgICAgICBldmVudC1pZA description: Link to the [event](#tag/Events). event-type: title: event-type enum: - onboarding-application-updated - decision-created - payment-created - transaction-created - verification-updated - admission-updated - verification-created - account-status-updated - onboarding-application-created - submission-created - test-event - admission-created - verification-resource-updated - account-status-created - verification-resource-created - submission-updated type: string description: >- The type of webhook event. Usually has the form {resource}-{operation}, e.g. payment-updated event-payload: type: object created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - event-url - event-type - event-payload title: event links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - events - links title: organization-events-response '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. /v0/organizations/{organization-id}/invitations: post: tags: - Invitations description: >- `POST` creates a new invitation to the organization. Sends an email invitation to join the `organization` to the specified `email-address`. parameters: - in: body name: request-create-invitation description: '' required: true schema: type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com required: - email-address title: request-create-invitation - type: string required: true name: organization-id in: path responses: '201': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '409': description: '' '422': description: '' summary: Create invitation /v0/organizations/{organization-id}/legal-persons: get: tags: - Legal persons 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: - in: query name: sort description: '' type: string required: false enum: - '-status-changed-at' - status-changed-at - '-created-at' - created-at - in: query name: include description: >- For each legal person returned, include its latest verification (if one exists), any roles in companies (significant control or directorship), and/or its latest risk rating (if one exists) in the response under the `included` attribute. type: array required: false x-allOf: - {} - {} items: enum: - company-roles - latest-risk-rating - latest-verification type: string - in: query name: filter[legal-person-status][in][] description: Return only legal persons with the given legal-person-status. type: array required: false x-allOf: - {} - {} items: enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string - in: query name: filter[application-status][eq] description: Return only legal persons with the given application-status. type: string required: false enum: - referred - errored - declined - submitted - accepted - in: query name: filter[has][] description: Return only legal persons with the given attributes. type: array required: false x-allOf: - {} - {} items: enum: - application-status type: string - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: legal-persons: type: array items: type: object properties: latest-decision: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: latest-decision description: The most recent [decision](#tag/Decisions) legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. latest-risk-rating-url: type: string title: latest-risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Legal-Person maxLength: 64 example: Company name application-status: title: application-status enum: - referred - errored - declined - submitted - accepted type: string description: >- Status of the current [application](/docs/terms/application) legal-person-status: title: legal-person-status enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string description: Status of the [legal person](#tag/Legal-persons) legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA legal-person-decisions-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-decisions-url description: >- Link to [decisions](#tag/Decisions) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions status-changed-at: title: status-changed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-claims-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-claims-url description: >- Link to the [claims](#tag/Claims) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims legal-person-bank-payees-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-bank-payees-url description: >- Link to the [payees](#tag/Payees) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees legal-person-verifications-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-verifications-url description: >- Link to all [verifications](#tag/Verifications) run against this [legal person](/docs/terms/legal-person). example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications legal-name: type: string title: legal-name description: A read-only, human readable label derived from claims legal-person-documents-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-documents-url description: >- Link to all evidence documents associated with this [legal person](/docs/terms/legal-person). 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 title: legal-person links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta required: - legal-persons - links title: '' description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List legal persons post: tags: - Legal persons description: >- Creates a new Legal Person. A collection of [Claims](#tag/Claims) may be provided. parameters: - in: body name: request-create-legal-person description: '' required: true schema: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account required: - display-name - legal-person-type title: request-create-legal-person - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: latest-decision: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: latest-decision description: The most recent [decision](#tag/Decisions) legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. latest-risk-rating-url: type: string title: latest-risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Legal-Person maxLength: 64 example: Company name application-status: title: application-status enum: - referred - errored - declined - submitted - accepted type: string description: Status of the current [application](/docs/terms/application) legal-person-status: title: legal-person-status enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string description: Status of the [legal person](#tag/Legal-persons) legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA legal-person-decisions-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-decisions-url description: >- Link to [decisions](#tag/Decisions) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions status-changed-at: title: status-changed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-claims-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-claims-url description: >- Link to the [claims](#tag/Claims) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims legal-person-bank-payees-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-bank-payees-url description: >- Link to the [payees](#tag/Payees) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees legal-person-verifications-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-verifications-url description: >- Link to all [verifications](#tag/Verifications) run against this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications legal-name: type: string title: legal-name description: A read-only, human readable label derived from claims legal-person-documents-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-documents-url description: >- Link to all evidence documents associated with this [legal person](/docs/terms/legal-person). 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 title: legal-person headers: Location: type: string description: The URL of the created legal-person description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: '' summary: Create legal person /v0/organizations/{organization-id}/legal-persons/search: post: tags: - Legal persons description: >- Returns a list of legal persons whose legal names match the `search-query` supplied in the request. Takes an optional 'equals onboarded' filter. parameters: - in: body name: organization-legal-persons-search description: '' required: true schema: type: object properties: search-query: title: search-query type: string minLength: 1 required: - search-query title: organization-legal-persons-search - in: query name: include description: >- For each legal person returned, include any roles in companies (significant control or directorship) in the response under the `included` attribute. type: array required: false x-allOf: - {} - {} items: enum: - company-roles type: string - in: query name: filter[legal-person-status][eq] description: Return only legal persons with the given legal-person-status. type: string required: false enum: - onboarded - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: search-results: type: array items: type: object properties: latest-decision: type: object properties: decision-outcome: title: decision-outcome type: string enum: - accepted - declined decision-notes: type: string title: decision-notes description: >- Free-text field to explain the reasons behind the decision. verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. decision-maker: title: decision-maker enum: - system - ops-user - user type: string description: >- Indicates if the decision was automated or made by a human. decision-user-url: type: string example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: >- Link to the [user](#tag/Users) that made the decision (if applicable). title: decision-user-url decision-ops-user: title: decision-ops-user enum: - griffin-ops-user type: string description: Indicates that an Ops user has created the decision. decision-user-username: type: string example: user@example.com description: >- Username of the [user](#tag/Users) that made the decision (if applicable). title: decision-user-username required: - legal-person-url - verification-url - decision-outcome - decision-maker - decision-notes - created-at title: latest-decision description: The most recent [decision](#tag/Decisions) legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. latest-risk-rating-url: type: string title: latest-risk-rating-url example: /v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA description: A contextual link to the risk rating. display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Legal-Person maxLength: 64 example: Company name application-status: title: application-status enum: - referred - errored - declined - submitted - accepted type: string description: >- Status of the current [application](/docs/terms/application) legal-person-status: title: legal-person-status enum: - restricted - onboarding-declined - onboarded - verified - onboarding type: string description: Status of the [legal person](#tag/Legal-persons) legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA legal-person-decisions-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-decisions-url description: >- Link to [decisions](#tag/Decisions) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions status-changed-at: title: status-changed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-claims-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-claims-url description: >- Link to the [claims](#tag/Claims) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims legal-person-bank-payees-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-bank-payees-url description: >- Link to the [payees](#tag/Payees) for this [legal person](/docs/terms/legal-person). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees legal-person-verifications-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-verifications-url description: >- Link to all [verifications](#tag/Verifications) run against this [legal person](/docs/terms/legal-person). example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications legal-name: type: string title: legal-name description: A read-only, human readable label derived from claims legal-person-documents-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-documents-url description: >- Link to all evidence documents associated with this [legal person](/docs/terms/legal-person). 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 title: legal-person meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta included: type: object properties: company-roles: type: array items: type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: >- A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA individual-company-roles: type: object additionalProperties: type: array items: {} uniqueItems: true title: individual-company-roles description: >- Each key identifies a company the individual holds a role in. Each value is a collection of company roles the individual has in the company specified by the key. required: - legal-person-url - individual-company-roles title: individual-company-roles- title: '' description: Present only when the request uses the `include` parameter. required: - meta - search-results title: legal-persons-search-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Search legal persons /v0/organizations/{organization-id}/memberships: get: tags: - Memberships description: >- Returns this [organization's](#tag/Organizations) [memberships](#tag/Memberships). parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: memberships: type: array items: type: object properties: membership-url: type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id title: membership-url description: Link to the [membership](#tag/Memberships). example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA membership-roles-url: type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id title: membership-roles-url description: >- Link to the assigned [roles](#tag/Roles) for this [membership](#tag/Memberships). example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles organization: type: object properties: own-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: own-legal-person-url description: >- Link to the [legal person](#tag/Legal-persons) that represents the [organization](#tag/Organizations); this can be an individual or a company. example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA organization-mode: title: organization-mode enum: - test-mode - live-mode type: string description: >- The organization can either be a sandbox organization or a live one; Check out our guide for [sandbox mode vs live mode](/docs/guides/sandbox-vs-live-mode). organization-memberships-url: type: string title: organization-memberships-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships description: >- Link to the [memberships](#tag/Memberships) for this [organization](#tag/Organizations). organization-invitations-url: type: string title: organization-invitations-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations description: >- Link to the resource that enables you to [invite](#tag/Invites) new [users](#tag/Users) to this [organization](#tag/Organizations). organization-payments-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-url description: >- Link to the [payments](#tag/Payments) associated with this organization. example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments organization-bank-account-products-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-account-products-url description: >- Link to the [bank account](#tag/Bank-accounts) products owned by this [organization](#tag/Organization). example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/products organization-onboarding-applications-url: type: string title: organization-onboarding-applications-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications description: >- Link to the [Reliance onboarding](#tag/Reliance-onboarding). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org organization-bank-accounts-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-accounts-search-url description: >- Link to search [bank accounts](#tag/Bank-accounts) associated with this [organization](#tag/Organizations). example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/search organization-api-keys-url: type: string title: organization-api-keys-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys organization-live-access-url: type: string title: organization-live-access-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access description: >- Link to the resource that enables you to request live access. organization-webhooks-url: type: string title: organization-webhooks-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks description: Link to the endpoint which enables webhook creation. organization-workflows-url: type: string title: organization-workflows-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows description: >- Link to the onboarding [workflows](#tag/Workflows) configured for this [organization](#tag/Organizations). organization-bank-accounts-url: type: string title: organization-bank-accounts-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts description: >- Link to the [bank accounts](#tag/Bank-accounts) managed by this [organization](#tag/Organizations). available-roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url description: Link to the [role](#tag/Roles). example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA role-category: type: string required: - display-name - description - role-url title: role description: >- The subset of [roles](#tag/Roles) available to [members](#tag/Members) of this [organization](#tag/Organizations). title: available-roles can-decide-on-verifications?: type: boolean title: can-decide-on-verifications? description: >- Is this organization able to make manual decisions on verifications? organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). organization-payments-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-search-url description: >- Link to search [payments](#tag/Payments) associated with this organization. example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments/search organization-individuals-url: type: string title: organization-individuals-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals organization-corporations-url: type: string title: organization-corporations-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations organization-legal-persons-url: type: string title: organization-legal-persons-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons description: >- Link to the [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-legal-persons-search-url: type: string title: organization-legal-persons-search-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons/search description: >- Link to search [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-events-url: type: string title: organization-events-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events description: >- Link to the endpoint which lists an organization's events. required: - available-roles - can-decide-on-verifications? - display-name - organization-api-keys-url - organization-bank-accounts-url - organization-bank-account-products-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-payments-url - organization-url - organization-webhooks-url - organization-workflows-url - own-legal-person-url - organization-legal-persons-search-url - organization-bank-accounts-search-url - organization-payments-search-url title: organization additionalProperties: false roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url description: Link to the [role](#tag/Roles). example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA role-category: type: string required: - display-name - description - role-url title: role title: roles description: Shows a collection of [roles](#tag/Roles). user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url description: Link to the user's [api keys](#tag/API-keys). example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url description: Link to the user's [memberships](#tag/Memberships). example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: user description: Shows the associated [user](#tag/Users). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - membership-url - membership-roles-url - organization - roles - user - created-at title: membership links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - memberships - links title: memberships-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List organization memberships /v0/organizations/{organization-id}/onboarding/applications: post: tags: - Reliance onboarding 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, check out our [onboarding guides](/docs/tags/onboarding). parameters: - in: body name: request-create-onboarding-application description: '' required: true schema: type: object properties: workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). subject-profile: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: >- Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account required: - display-name - claims x-allOf: - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: >- Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - >- the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: >- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account required: - display-name - claims - {} title: subject-profile description: |- The subject profile to be onboarded. Directors and PSCs must be declared via `subject-association` in related profiles instead of director & PSC claims in the subject profile. related-profiles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity subject-association: type: object properties: 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 x-allOf: - 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: type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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: object properties: {} title: senior-manager governing-body-member: type: object properties: {} title: governing-body-member senior-manager-function-holder: type: object properties: {} title: senior-manager-function-holder role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] x-allOf: - type: object properties: 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 x-allOf: - 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: type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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: object properties: {} title: senior-manager governing-body-member: type: object properties: {} title: governing-body-member senior-manager-function-holder: type: object properties: {} title: senior-manager-function-holder role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] - {} title: subject-association description: >- The relationship with the subject profile. Choose at least one of the subject associations. claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: >- Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - >- the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account required: - display-name - subject-association - claims x-allOf: - type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity subject-association: type: object properties: 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 x-allOf: - 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: type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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: object properties: {} title: senior-manager governing-body-member: type: object properties: {} title: governing-body-member senior-manager-function-holder: type: object properties: {} title: senior-manager-function-holder role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] x-allOf: - type: object properties: 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 x-allOf: - 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: type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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: object properties: {} title: senior-manager governing-body-member: type: object properties: {} title: governing-body-member senior-manager-function-holder: type: object properties: {} title: senior-manager-function-holder role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] - {} title: subject-association description: >- The relationship with the subject profile. Choose at least one of the subject associations. claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: >- Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - >- the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: >- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: >- ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account required: - display-name - subject-association - claims - {} title: related-profile title: related-profiles description: >- A list profiles related to the subject (e.g. directors, person with significant control). required: - workflow-url - subject-profile title: request-create-onboarding-application - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: onboarding-application-url: type: string title: onboarding-application-url example: /v0/onboarding/applications/oa.b25ib2FyZGluZy1hcHBsaQ description: Link to the onboarding application. onboarding-application-status: title: onboarding-application-status type: string enum: - processing - submitted - errored - complete required: - onboarding-application-url - onboarding-application-status title: onboarding-application-created-response headers: Location: type: string description: The URL of the application description: The created application '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: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '422': description: >- Unprocessable Entity: specific error details will be provided, if available summary: Create an onboarding application /v0/organizations/{organization-id}/open-banking/tell-consents: post: tags: - Open banking description: |- Register a Tell consent for open banking on your customers' accounts. After granting a consent with Tell Money, register it with Griffin so that Griffin can validate Tell's subsequent resource requests. `tell-consent-permissions` behaviour depends on `tell-consent-scope`: - `accounts` scope requires at least one permission; this controls which AISP operations the TPP can perform (e.g. reading balances or transactions). - `payments` scope does not use permissions — Tell Money returns them empty and Griffin authorises payment operations from the scope alone. Pass `[]` (matching Tell's response) or any value; the field is still required in the request. parameters: - in: body name: request-register-tell-consent description: '' required: true schema: type: object properties: tell-consent-id: type: string format: uuid tell-gateway-id: type: string format: uuid tell-consent-scope: type: string enum: - payments - accounts tell-consent-permissions: type: array items: type: string enum: - ReadPartyPSU - ReadTransactionsDetail - ReadProducts - ReadStatementsDetail - ReadDirectDebits - ReadTransactionsDebits - ReadTransactionsCredits - ReadBeneficiariesDetail - ReadBalances - ReadPAN - ReadScheduledPaymentsDetail - ReadAccountsDetail - ReadAccountsBasic - ReadOffers - ReadBeneficiariesBasic - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadTransactionsBasic - ReadParty - ReadStatementsBasic - ReadScheduledPaymentsBasic uniqueItems: true description: >- Permissions granted by the consent. For `accounts` scope, must list at least one permission. For `payments` scope, pass `[]` — Tell Money returns no permissions and Griffin authorises payments from the scope alone. bank-account-urls: type: array items: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. tell-consent-expiry: title: inst format: date-time type: string description: ISO 8601 formatted date-time. required: - tell-consent-id - tell-gateway-id - tell-consent-scope - tell-consent-permissions - bank-account-urls x-allOf: - type: object properties: {} required: [] - {} title: request-register-tell-consent - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: tell-consent-expiry: title: tell-consent-expiry format: date-time type: string description: ISO 8601 formatted date-time. tell-gateway-id: type: string format: uuid title: tell-gateway-id created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. tell-consent-id: type: string format: uuid title: tell-consent-id tell-consent-scope: type: string title: tell-consent-scope x-anyOf: - type: string enum: - payments - accounts - type: string tell-consent-consumed-at: title: tell-consent-consumed-at format: date-time type: string description: ISO 8601 formatted date-time. tell-consent-url: type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id - type: string x-allOf: - type: string - {} - type: object properties: consent-id: type: string format: uuid required: - consent-id title: tell-consent-url example: >- /v0/open-banking/tell-consents/00000000-0000-0000-0000-000000000000 tell-consent-status: type: string title: tell-consent-status x-anyOf: - type: string enum: - revoked - consumed - authorised - type: string tell-consent-permissions: type: array items: type: string title: tell-consent-permission x-anyOf: - type: string enum: - ReadPartyPSU - ReadTransactionsDetail - ReadProducts - ReadStatementsDetail - ReadDirectDebits - ReadTransactionsDebits - ReadTransactionsCredits - ReadBeneficiariesDetail - ReadBalances - ReadPAN - ReadScheduledPaymentsDetail - ReadAccountsDetail - ReadAccountsBasic - ReadOffers - ReadBeneficiariesBasic - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadTransactionsBasic - ReadParty - ReadStatementsBasic - ReadScheduledPaymentsBasic - type: string bank-account-urls: type: array items: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. tell-consent-revoked-at: title: tell-consent-revoked-at format: date-time type: string description: ISO 8601 formatted date-time. required: - tell-consent-url - tell-consent-id - tell-gateway-id - bank-account-urls - tell-consent-scope - tell-consent-permissions - tell-consent-status - created-at title: tell-consent-response description: A registered Tell consent. description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: Gateway not found. '409': description: Consent with this ID already exists. '422': description: At least one of the supplied bank accounts doesn't exist. summary: Register Tell consent /v0/organizations/{organization-id}/payments: get: tags: - Payments description: List payments in your organization. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: include description: >- For each payment returned, include its bank account, latest submission (if one exists), rejecting user (if one exists), and/or creating user (if one exists) in the response under the `included` attribute. type: array required: false x-allOf: - {} - {} items: enum: - bank-account - rejected-by - latest-submission.created-by - created-by - latest-submission type: string - in: query name: filter[rejected][eq] description: >- Specifies whether the payment has been [rejected](/docs/guides/payment-approvals). type: boolean required: false - in: query name: filter[payment-direction][eq] description: Whether the payment is moving money into or out of the account. type: string required: false enum: - inbound-payment - outbound-payment - in: query name: filter[latest-submission-status][in][] description: '' type: array required: false x-allOf: - {} - {} items: enum: - scheduled - failed - processing - returned - delivered type: string x-anyOf: - title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. - enum: - 'null' type: string title: no-latest-submission-status description: No latest submission status - in: query name: filter[created-at][lte] description: >- Return only resources with a created-at less than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][lt] description: >- Return only resources with a created-at less than the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gte] description: >- Return only resources with a created-at greater than or equal to the given timestamp. type: string required: false format: date-time - in: query name: filter[created-at][gt] description: >- Return only resources with a created-at greater than the given timestamp. type: string required: false format: date-time - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: payments: type: array items: type: object properties: creditor: type: object properties: {} required: - creditor-type title: creditor x-anyOf: - type: object properties: account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. creditor-type: enum: - griffin-bank-account type: string required: - account-url - creditor-type title: griffin-bank-account - type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: >- [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true creditor-type: enum: - uk-domestic type: string bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: >- Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: - creditor-type title: uk-domestic description: Creditor specified with bank details rejected-at: title: rejected-at format: date-time type: string description: ISO 8601 formatted date-time. latest-submission-url: type: string example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA title: latest-submission-url description: Most recent submission (if any made) rejected-by-url: type: string title: rejected-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. payment-direction: title: payment-direction enum: - inbound-payment - outbound-payment type: string description: >- Whether the payment is moving money into or out of the account. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-via: title: created-via type: string enum: - api - ui created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. payment-reference: title: payment-reference type: string description: >- Free-text field to help identify and categorise payments. maxLength: 35 example: test reference minLength: 1 payment-amount: title: payment-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false x-allOf: - title: money-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false - x-allOf: - x-allOf: - {} - {} - {} description: >- Compound value representing both the currency and amount of money being sent. ultimate-debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor payment-admissions-url: type: string title: payment-admissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions description: Link to the endpoint for listing payment admissions. payment-submissions-url: type: string title: payment-submissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions description: >- Link to the endpoint for creating and listing payment submissions. debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor rejection-reason: title: non-empty-string type: string minLength: 1 x-nullable: true required: - created-at - payment-amount - payment-url - payment-direction title: payment links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - links - payments title: '' description: Present only when the request uses the `include` parameter. description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. /v0/organizations/{organization-id}/payments/search: post: tags: - Payments description: >- Returns a list of payments which reference or scheme ID match the `search-query` supplied in the request. parameters: - in: body name: payments-search description: '' required: true schema: type: object properties: search-query: title: search-query type: string minLength: 1 required: - search-query title: payments-search - in: query name: include description: >- For each payment returned, include its bank account, latest submission (if one exists), rejecting user (if one exists), and/or creating user (if one exists) in the response under the `included` attribute. type: array required: false x-allOf: - {} - {} items: enum: - bank-account - rejected-by - latest-submission.created-by - created-by - latest-submission type: string - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: search-results: type: array items: type: object properties: creditor: type: object properties: {} required: - creditor-type title: creditor x-anyOf: - type: object properties: account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. creditor-type: enum: - griffin-bank-account type: string required: - account-url - creditor-type title: griffin-bank-account - type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: >- [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true creditor-type: enum: - uk-domestic type: string bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: >- Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: - creditor-type title: uk-domestic description: Creditor specified with bank details rejected-at: title: rejected-at format: date-time type: string description: ISO 8601 formatted date-time. latest-submission-url: type: string example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA title: latest-submission-url description: Most recent submission (if any made) rejected-by-url: type: string title: rejected-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. payment-direction: title: payment-direction enum: - inbound-payment - outbound-payment type: string description: >- Whether the payment is moving money into or out of the account. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-via: title: created-via type: string enum: - api - ui created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. payment-reference: title: payment-reference type: string description: >- Free-text field to help identify and categorise payments. maxLength: 35 example: test reference minLength: 1 payment-amount: title: payment-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false x-allOf: - title: money-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false - x-allOf: - x-allOf: - {} - {} - {} description: >- Compound value representing both the currency and amount of money being sent. ultimate-debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor payment-admissions-url: type: string title: payment-admissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions description: Link to the endpoint for listing payment admissions. payment-submissions-url: type: string title: payment-submissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions description: >- Link to the endpoint for creating and listing payment submissions. debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor rejection-reason: title: non-empty-string type: string minLength: 1 x-nullable: true required: - created-at - payment-amount - payment-url - payment-direction title: payment meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta included: type: object properties: accounts: type: array items: type: object properties: account-submissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-submissions-url example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/submissions description: >- Link to the [payment submissions](#tag/Payments) debiting from this account. bank-account-product-url: type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id - type: string x-allOf: - type: string - {} - type: object properties: bank-product-id: type: string format: '' title: bank-product-id required: true name: bank-product-id required: - bank-product-id title: bank-account-product-url example: /v0/bank/products/bp.IGJhbmstcHJvZHVjdC1pZA description: >- Link to the [bank account](#tag/Bank-accounts) product. account-restricted: type: boolean title: account-restricted description: >- Specifies whether the bank account has restrictions applied by Griffin. account-payments-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-payments-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments description: >- Link to the [payments](#tag/Payments) associated with this account. pooled-account-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-memberships-url example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership description: >- Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. account-admissions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-admissions-url example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/admissions description: >- Link to the [payment admissions](#tag/Payments) crediting to this account. bank-product-type: title: bank-product-type enum: - savings-account - client-money-account - safeguarding-account - embedded-account - operational-account type: string description: >- Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity controller-url: type: string title: controller-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. pooled-funds: type: boolean title: pooled-funds description: >- Specifies whether the bank account holds funds belonging to multiple beneficiaries. accrued-interest: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: accrued-interest description: >- Shows the [accrued interest](/docs/terms/accrued-interest). account-status: title: account-status enum: - closing - open - closed - opening type: string 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. client-money-type: title: client-money-type enum: - designated-client-fund - designated-client-money - general-client-money type: string description: Specifies the type of client money account. owner-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. title: owner-url closed-at: title: closed-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. opened-at: title: opened-at format: date-time type: string description: ISO 8601 formatted date-time. close-account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: close-account-url description: >- Link to the endpoint that enables account closure for this account. available-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: available-balance description: >- Shows the [available balance](/docs/terms/available-balance). pooled-account-membership-updates-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: pooled-account-membership-updates-url example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/membership-updates description: >- Link to manage [pooled account membership](#tag/Pooled-account-membership) bank-account-restrictions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-restrictions-url example: >- /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/restrictions description: >- Link to the [restrictions](#tag/Bank-account-restrictions) on this account. bank-addresses: type: array items: type: object properties: account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. 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 title: bank-address 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. account-transactions-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-transactions-url description: >- Link to the [transactions](#tag/Transactions) associated with this account. account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. bank-account-events-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: bank-account-events-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/events description: Link to the events for this bank account. beneficiary-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. title: beneficiary-url primary-account: type: boolean title: primary-account description: >- Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). example: false account-balance: required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false title: account-balance description: >- Shows the [account balance](/docs/terms/account-balance). savings-type: title: savings-type enum: - easy-access - bare-trust type: string description: Specifies the type of savings account. required: - account-balance - accrued-interest - available-balance - account-payments-url - account-admissions-url - account-submissions-url - account-transactions-url - account-url - owner-url - controller-url - display-name - account-restricted - account-status - bank-product-type - pooled-funds - created-at - primary-account title: bank-account submissions: type: array items: type: object properties: submission-scheme-information: type: object properties: {} required: - payment-scheme title: submission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. scheme-status-code: type: string minLength: 1 title: scheme-status-code description: >- A scheme-specific code describing the current status. scheme-status-code-description: type: string minLength: 1 title: scheme-status-code-description description: >- A human-readable description of the scheme status code. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer submission-status: title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. scheduled-at: title: scheduled-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. submission-status-reason: title: submission-status-reason type: string minLength: 1 payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. submission-url: type: string title: submission-url example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA required: - submission-status - submission-scheme-information - payment-url - created-at - submission-url - account-url title: submission users: type: array items: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: user description: Shows the associated [user](#tag/Users). title: '' description: Present only when the request uses the `include` parameter. required: - search-results - meta title: payments-search-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Search payments /v0/organizations/{organization-id}/webhooks: get: tags: - Webhooks description: Get all webhooks for the organization parameters: - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: organization-webhooks: type: array items: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. activate-webhook-url: type: string title: activate-webhook-url description: Activate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate deactivate-webhook-url: type: string title: deactivate-webhook-url description: Deactivate a webhook example: >- /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. webhook-state: title: webhook-state enum: - inactive - active type: string description: The state of the webhook. created-by: type: string title: created-by example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). test-webhook-url: type: string title: test-webhook-url description: Test a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test webhook-url: type: string title: webhook-url example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA description: Link to the [webhook](#tag/Webhooks). webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ required: - organization-url - webhook-url - webhook-destination-url - test-webhook-url - created-at - webhook-state - activate-webhook-url - deactivate-webhook-url title: webhook required: - organization-webhooks title: organization-webhooks-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. post: tags: - Webhooks description: Create a webhook parameters: - in: body name: request-create-webhook description: '' required: true schema: type: object properties: webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook required: - webhook-destination-url title: request-create-webhook - type: string required: true name: organization-id in: path responses: '201': schema: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. activate-webhook-url: type: string title: activate-webhook-url description: Activate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate deactivate-webhook-url: type: string title: deactivate-webhook-url description: Deactivate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. webhook-state: title: webhook-state enum: - inactive - active type: string description: The state of the webhook. created-by: type: string title: created-by example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). test-webhook-url: type: string title: test-webhook-url description: Test a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test webhook-url: type: string title: webhook-url example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA description: Link to the [webhook](#tag/Webhooks). webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ required: - organization-url - webhook-url - webhook-destination-url - test-webhook-url - created-at - webhook-state - activate-webhook-url - deactivate-webhook-url title: webhook headers: Location: type: string description: The URL of the webhook description: The newly-created webhook '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '422': description: '' /v0/organizations/{organization-id}/workflows: get: tags: - Workflows description: >- Lists workflows for use when creating a [verification](#tag/Verifications). parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: organization-id in: path responses: '200': schema: type: object properties: workflows: type: array items: type: object properties: workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. disabled?: type: boolean title: disabled? description: >- When a workflow is disabled, no new verifications using that workflow can be created. required-claim-types: type: object additionalProperties: type: array items: title: claim-type type: string enum: - mobile-number - properties-origins-of-deposits - individual-identity - sole-trader - property-types - commercial-property-industries - uk-company-register - individual-income - business-website - initial-deposit - international-payments-countries - company-telephone-number - managed-properties - business-size - entity-address - person-with-significant-control - business-industry - tax-residencies - tenant-cash-payments - verified-bank-account - company-email-address - tax-residency - uk-financial-services-register - non-tenant-balance - business-description - hmrc-register - external-risk-rating - nfe-classification - vat-registration - entity-name - hmo-license - business-email-address - client-money-protection-scheme - fca-mutuals-register - individual-sources-of-funds - nominal-person-with-significant-control - hmo-verification - commercial-property-ratio - governing-body-member - business-address - employment - annual-turnover - purposes-of-account - sic-codes - international-operations-countries - balance-sheet-size - us-citizen - role-titles - sources-of-funds - senior-manager-function-holder - business-owner - business-telephone-number - individual-email-address - tax-identification-numbers-by-country - business-start-date - contact-details - reliance-verification - ultimate-beneficial-owner - aeoi-entity-classification - business-name - individual-purposes-of-account - nationality - trading-name - number-of-employees - social-media - trading-address - company-website - director - complex-business-structure - alternative-number - cash-payments - fca-fs-register-firm - tax-identification-number - fca-fs-register-individual - individual-residence - business-type uniqueItems: true title: required-claim-types description: |- A mapping of workflow-appropriate legal person types to claims that are required for each type. workflow-rules: type: array items: type: string enum: - allow-zero-directors - allow-missing-directors uniqueItems: true title: workflow-rules description: A list of special behaviours a workflow can possess. required: - workflow-url - display-name - description - legal-person-type - created-at - disabled? title: workflow links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links meta: type: object properties: page: type: object properties: total: type: integer format: int64 minimum: 0 title: total description: >- Total number of items. Present when the total number of items in the full result set is less than 10,000. estimated-total: type: object properties: at-least: enum: - 10000 type: integer 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. title: estimated-total title: page title: meta required: - workflows - links title: organization-workflows-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List organization workflows /v0/payees/{payee-id}: get: tags: - Payees description: Returns the payee details. parameters: - type: string required: true name: payee-id in: path responses: '200': schema: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). payee-url: type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id title: payee-url example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA description: Link to the [payee](#tag/Payees). account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 account-holder: type: string minLength: 1 title: account-holder description: The name of the [account holder](/docs/terms/account-holder). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. payee-status: title: payee-status enum: - deactivated - active type: string description: >- The status of the payee; you can only make payments to active payees. country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB required: - account-holder - account-number - bank-id - country-code - created-at - legal-person-url - payee-status - payee-url title: payee description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get payee patch: tags: - Payees description: >- Updates an existing payee. You can update a payee with the outcome of a [CoP request](#tag/Confirmation-of-payee) by supplying a `cop-request-url`. 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: - in: body name: request-update-bank-payee description: '' required: true schema: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). payee-status: title: payee-status enum: - deactivated type: string description: >- The status of the payee; you can only make payments to active payees. title: request-update-bank-payee - type: string required: true name: payee-id in: path responses: '200': schema: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). payee-url: type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id - type: string x-allOf: - type: string - {} - type: object properties: payee-id: type: string format: '' title: payee-id required: true name: payee-id required: - payee-id title: payee-url example: /v0/payees/pe.ICAgICAgICBwYXllZS1pZA description: Link to the [payee](#tag/Payees). account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 account-holder: type: string minLength: 1 title: account-holder description: The name of the [account holder](/docs/terms/account-holder). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. payee-status: title: payee-status enum: - deactivated - active type: string description: >- The status of the payee; you can only make payments to active payees. country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB required: - account-holder - account-number - bank-id - country-code - created-at - legal-person-url - payee-status - payee-url title: payee description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '409': description: '' '422': description: '' '500': description: '' summary: Update payee /v0/payments/{payment-id}: get: tags: - Payments description: Yields payment details parameters: - type: string required: true name: payment-id in: path responses: '200': schema: type: object properties: created-by-user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: created-by-user description: Shows the associated [user](#tag/Users). creditor: type: object properties: {} required: - creditor-type title: creditor x-anyOf: - type: object properties: account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. creditor-type: enum: - griffin-bank-account type: string required: - account-url - creditor-type title: griffin-bank-account - type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true creditor-type: enum: - uk-domestic type: string bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: - creditor-type title: uk-domestic description: Creditor specified with bank details rejected-at: title: rejected-at format: date-time type: string description: ISO 8601 formatted date-time. latest-submission-url: type: string example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA title: latest-submission-url description: Most recent submission (if any made) rejected-by-url: type: string title: rejected-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. payment-direction: title: payment-direction enum: - inbound-payment - outbound-payment type: string description: >- Whether the payment is moving money into or out of the account. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-via: title: created-via type: string enum: - api - ui created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. payment-reference: title: payment-reference type: string description: Free-text field to help identify and categorise payments. maxLength: 35 example: test reference minLength: 1 payment-amount: title: payment-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false x-allOf: - title: money-amount required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP value: type: string title: value description: The value as a decimal-formatted string example: '1000.00' type: object additionalProperties: false - x-allOf: - x-allOf: - {} - {} - {} description: >- Compound value representing both the currency and amount of money being sent. ultimate-debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor payment-admissions-url: type: string title: payment-admissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions description: Link to the endpoint for listing payment admissions. payment-submissions-url: type: string title: payment-submissions-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions description: >- Link to the endpoint for creating and listing payment submissions. debtor: type: object properties: iban: title: iban pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ type: string description: An International Bank Account Number. maxLength: 34 example: GB42GFNB12345612345678 minLength: 5 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 bic: title: bic pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' type: string description: A BIC. maxLength: 11 example: GFNBGB22 minLength: 8 account-number: example: '12345678' x-allOf: - type: string - {} minLength: 8 maxLength: 8 deprecated: true title: account-number pattern: ^[0-9]{8}$ type: string description: A UK account number. account-holder: type: string minLength: 1 title: account-holder description: >- The name of the [account holder](/docs/terms/account-holder). bank-id-code: title: bank-id-code type: string enum: - gbdsc deprecated: true bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 deprecated: true bban: title: bban pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: A country-specific Basic Bank Account Number. maxLength: 30 example: GFNB12345612345678 minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 other-account-identification: title: other-account-identification type: string description: Uncategorised account identification maxLength: 64 example: ABC123 minLength: 1 account-number-code: title: account-number-code type: string enum: - bban deprecated: true other-institution-identification: title: other-institution-identification type: string description: Uncategorised financial institution identification maxLength: 64 example: ABC123 minLength: 1 required: [] title: debtor rejection-reason: title: non-empty-string type: string minLength: 1 x-nullable: true rejected-by-user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: rejected-by-user description: Shows the associated [user](#tag/Users). required: - created-at - payment-amount - payment-direction - payment-url description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get payment patch: tags: - Payments description: Updates a payment parameters: - in: body name: request-update-payment description: '' required: true schema: type: object properties: rejection-reason: title: non-empty-string type: string minLength: 1 x-nullable: true description: Specify null for rejection-reason to reject without a reason. title: request-update-payment - type: string required: true name: payment-id in: path responses: '204': description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '409': description: >- An error occurred when trying to update the payment. See [https://docs.griffin.com/docs/errors/payment](https://docs.griffin.com/docs/errors/payment) for details. '422': description: '' '500': description: '' /v0/payments/{payment-id}/admissions: get: tags: - Payments description: >- Lists admissions for a payment. A payment may have at most one admission. parameters: - type: string required: true name: payment-id in: path responses: '200': schema: type: object properties: admissions: type: array items: type: object properties: admission-status: title: admission-status enum: - cancelled - processing - returned - delivered type: string description: Specifies the progress of the inbound payment. admission-scheme-information: type: object properties: {} required: - payment-scheme title: admission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer - type: object properties: payment-scheme: enum: - chaps type: string title: chaps required: - payment-scheme - type: object properties: payment-scheme: enum: - bacs type: string title: bacs required: - payment-scheme payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. admission-url: type: string title: admission-url example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. original-unique-scheme-identifier: type: string title: original-unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 required: - admission-status - admission-scheme-information - payment-url - created-at - admission-url - unique-scheme-identifier - account-url title: admission required: - admissions title: admissions-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List payment admissions /v0/payments/{payment-id}/submissions: get: tags: - Payments description: >- Lists submissions for a payment. The presence of a submission means that the payment has been submitted. parameters: - type: string required: true name: payment-id in: path responses: '200': schema: type: object properties: submissions: type: array items: type: object properties: submission-scheme-information: type: object properties: {} required: - payment-scheme title: submission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. scheme-status-code: type: string minLength: 1 title: scheme-status-code description: >- A scheme-specific code describing the current status. scheme-status-code-description: type: string minLength: 1 title: scheme-status-code-description description: >- A human-readable description of the scheme status code. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer submission-status: title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. scheduled-at: title: scheduled-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. submission-status-reason: title: submission-status-reason type: string minLength: 1 payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. submission-url: type: string title: submission-url example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA required: - submission-status - submission-scheme-information - payment-url - created-at - submission-url - account-url title: submission required: - submissions title: submissions-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: List payment submissions post: tags: - Payments description: >- Submits a previously created payment for execution. You can submit payments over different payment schemes, check out our [payments guides](docs/guides/payments-overview) to help decide which scheme best suites your use case. parameters: - in: body name: request-create-payment-submission description: '' required: true schema: type: object properties: payment-scheme: title: payment-scheme enum: - fps - book-transfer type: string description: Specifies the scheme over which a payment is executed. required: - payment-scheme title: request-create-payment-submission - type: string required: true name: payment-id in: path responses: '200': schema: type: object properties: submission-scheme-information: type: object properties: {} required: - payment-scheme title: submission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. scheme-status-code: type: string minLength: 1 title: scheme-status-code description: A scheme-specific code describing the current status. scheme-status-code-description: type: string minLength: 1 title: scheme-status-code-description description: >- A human-readable description of the scheme status code. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer submission-status: title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. scheduled-at: title: scheduled-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. submission-status-reason: title: submission-status-reason type: string minLength: 1 payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. submission-url: type: string title: submission-url example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA required: - submission-status - submission-scheme-information - payment-url - created-at - submission-url - account-url title: submission description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '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. '429': description: '' summary: Submit payment /v0/roles: get: tags: - Roles description: Yields a list of all Role resources. security: [] responses: '200': schema: type: object properties: roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). role-category: type: string required: - display-name - description - role-url title: role title: roles description: Shows a collection of [roles](#tag/Roles). required: - roles title: roles-response description: '' parameters: [] summary: List roles /v0/roles/{role-id}: get: tags: - Roles description: Yields the Role resource. security: [] parameters: - type: string required: true name: role-id in: path responses: '200': schema: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA description: Link to the [role](#tag/Roles). role-category: type: string required: - display-name - description - role-url title: role description: '' '400': description: '' '404': description: '' summary: Get role /v0/security/message-signature/verify: get: tags: - Message Signatures description: Yields the status of the http signature validation security: [] parameters: - type: string in: header name: header-signature description: >- Message Signatures: signature header containing a signature label with the components used to generate the signature - type: string in: header name: header-signature-input description: >- Message Signatures: signature-input header containing a signature label with the components used to generate the signature responses: '200': schema: type: object properties: message: type: string busy: type: boolean required: - message - busy title: httpsig-debug-response description: '' summary: HTTP Signature Debug post: tags: - Message Signatures description: Yields the status of the http signature validation security: [] parameters: - type: string in: header name: header-signature description: >- Message Signatures: signature header containing a signature label with the components used to generate the signature - type: string in: header name: header-signature-input description: >- Message Signatures: signature-input header containing a signature label with the components used to generate the signature responses: '200': schema: type: object properties: message: type: string busy: type: boolean required: - message - busy title: httpsig-debug-response description: '' put: tags: - Message Signatures description: Yields the status of the http signature validation security: [] parameters: - type: string in: header name: header-signature description: >- Message Signatures: signature header containing a signature label with the components used to generate the signature - type: string in: header name: header-signature-input description: >- Message Signatures: signature-input header containing a signature label with the components used to generate the signature responses: '200': schema: type: object properties: message: type: string busy: type: boolean required: - message - busy title: httpsig-debug-response description: '' delete: tags: - Message Signatures description: Yields the status of the http signature validation security: [] parameters: - type: string in: header name: header-signature description: >- Message Signatures: signature header containing a signature label with the components used to generate the signature - type: string in: header name: header-signature-input description: >- Message Signatures: signature-input header containing a signature label with the components used to generate the signature responses: '200': schema: type: object properties: message: type: string busy: type: boolean required: - message - busy title: httpsig-debug-response description: '' patch: tags: - Message Signatures description: Yields the status of the http signature validation security: [] parameters: - type: string in: header name: header-signature description: >- Message Signatures: signature header containing a signature label with the components used to generate the signature - type: string in: header name: header-signature-input description: >- Message Signatures: signature-input header containing a signature label with the components used to generate the signature responses: '200': schema: type: object properties: message: type: string busy: type: boolean required: - message - busy title: httpsig-debug-response description: '' /v0/simulation/organizations/{organization-id}/cop-request/simulate/{cop-simulation-type}: post: tags: - Confirmation of payee description: >- Simulate the creation of a CoP Request. Note: This is an alpha API and may change anytime. parameters: - in: body name: create-cop-request description: '' required: true schema: type: object properties: account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-classification: title: account-classification type: string enum: - personal - business name: title: name description: The name of the payee. example: John Smith requester-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: requester-legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). secondary-reference-data: title: secondary-reference-data description: >- Secondary reference data, such as a building society roll number or a credit card number. example: '1234567890' required: - account-number - bank-id - account-classification - name - requester-legal-person-url title: create-cop-request - type: string required: true name: organization-id in: path - enum: - match-name-business-personal - account-not-found - full-match - no-match-name - no-match-secondary-ref - close-match-name-business-personal - close-match-name-personal-business - account-switched - close-match-name - account-not-supported - match-name-personal-business type: string description: The type of simulation to run. in: path name: cop-simulation-type required: true responses: '201': schema: type: object properties: cop-request-url: type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id - type: string x-allOf: - type: string - {} - type: object properties: cop-request-id: type: string format: '' title: cop-request-id required: true name: cop-request-id required: - cop-request-id title: cop-request-url example: /v0/cop-request/cp.ICBjb3AtcmVxdWVzdC1pZA description: Link to a [CoP request](#tag/Confirmation-of-payee). account: type: object properties: account-number: type: string x-allOf: - type: string - {} title: account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 bank-id: title: bank-id pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 account-classification: title: account-classification type: string enum: - personal - business name: title: name description: The name of the payee. example: John Smith requester-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: requester-legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). secondary-reference-data: title: secondary-reference-data description: >- Secondary reference data, such as a building society roll number or a credit card number. example: '1234567890' required: - account-number - bank-id - account-classification - name - requester-legal-person-url title: account description: The payee's account details. cop-response: type: object properties: status: title: status type: string enum: - verified - unverified result: title: result type: string enum: - match - close-match - no-match reason: title: reason type: string enum: - no-match-name - account-not-supported - match-name-business-personal - match-name-personal-business - close-match-name-business-personal - no-match-secondary-ref - close-match-name - account-switched - close-match-name-personal-business suggested-name: type: string title: suggested-name description: >- The suggested name of the payee. Only present on a close match. suggested-account-classification: title: suggested-account-classification enum: - personal - business type: string description: >- The suggested account classification. Only present on a close match. example: business required: - status - result title: cop-response description: The outcome of the CoP request required: - cop-request-url - account - cop-response title: cop-request description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' '409': description: '' '422': description: '' summary: '[Alpha] Simulate a CoP request' /v0/submissions/{submission-id}: get: tags: - Payments description: Yields a submission. parameters: - type: string required: true name: submission-id in: path responses: '200': schema: type: object properties: submission-scheme-information: type: object properties: {} required: - payment-scheme title: submission-scheme-information x-anyOf: - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. scheme-status-code: type: string minLength: 1 title: scheme-status-code description: A scheme-specific code describing the current status. scheme-status-code-description: type: string minLength: 1 title: scheme-status-code-description description: >- A human-readable description of the scheme status code. payment-scheme: enum: - fps type: string required: - end-to-end-identification - payment-scheme title: fps - type: object properties: end-to-end-identification: title: end-to-end-identification type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: >- An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. payment-scheme: enum: - book-transfer type: string required: - end-to-end-identification - payment-scheme title: book-transfer submission-status: title: submission-status enum: - scheduled - failed - processing - returned - delivered type: string description: Specifies the progress of the outbound payment. created-by-url: type: string title: created-by-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. scheduled-at: title: scheduled-at format: date-time type: string description: ISO 8601 formatted date-time. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. submission-status-reason: title: submission-status-reason type: string minLength: 1 payment-url: type: string title: payment-url example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA description: Link to the payment resource. unique-scheme-identifier: type: string title: unique-scheme-identifier maxLength: 140 example: 'PGIT2IS7AJG77D2HK23020240212826NatWes ' minLength: 1 account-url: type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id - type: string x-allOf: - type: string - {} - type: object properties: bank-account-id: type: string format: '' title: bank-account-id required: true name: bank-account-id required: - bank-account-id title: account-url example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA description: Link to the bank account resource. submission-url: type: string title: submission-url example: /v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA required: - submission-status - submission-scheme-information - payment-url - created-at - submission-url - account-url title: submission description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '403': description: '' '404': description: '' summary: Get payment submission /v0/users/{user-id}: get: tags: - Users description: Get the User resource for the current user. parameters: - type: string required: true name: user-id in: path responses: '200': schema: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys description: Link to the user's [api keys](#tag/API-keys). user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships description: Link to the user's [memberships](#tag/Memberships). given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: user description: Shows the associated [user](#tag/Users). description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get user /v0/users/{user-id}/api-keys: get: tags: - API keys description: List all your active API keys. parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: user-id in: path responses: '200': schema: type: object properties: api-keys: type: array items: type: object properties: api-key-url: type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id - type: string x-allOf: - type: string - {} - type: object properties: api-key-id: type: string format: '' title: api-key-id required: true name: api-key-id required: - api-key-id title: api-key-url description: The resource path for the API key example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA api-key-name: title: api-key-name pattern: ^[a-zA-z0-9-_]+ description: The immutable display name for the API key maxLength: 64 example: buildserver minLength: 1 api-key-live?: type: boolean organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - api-key-url - api-key-name - api-key-live? - organization-url - user-url - created-at title: api-key links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - api-keys - links title: api-keys-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List API keys /v0/users/{user-id}/memberships: get: tags: - Memberships description: Returns this [user's](#tag/Users) [memberships](#tag/Memberships). parameters: - in: query name: sort description: '' type: string required: false enum: - '-created-at' - created-at - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: user-id in: path responses: '200': schema: type: object properties: memberships: type: array items: type: object properties: membership-url: type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id title: membership-url description: Link to the [membership](#tag/Memberships). example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA membership-roles-url: type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id - type: string x-allOf: - type: string - {} - type: object properties: membership-id: type: string format: '' title: membership-id required: true name: membership-id required: - membership-id title: membership-roles-url description: >- Link to the assigned [roles](#tag/Roles) for this [membership](#tag/Memberships). example: /v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles organization: type: object properties: own-legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: own-legal-person-url description: >- Link to the [legal person](#tag/Legal-persons) that represents the [organization](#tag/Organizations); this can be an individual or a company. example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA organization-mode: title: organization-mode enum: - test-mode - live-mode type: string description: >- The organization can either be a sandbox organization or a live one; Check out our guide for [sandbox mode vs live mode](/docs/guides/sandbox-vs-live-mode). organization-memberships-url: type: string title: organization-memberships-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships description: >- Link to the [memberships](#tag/Memberships) for this [organization](#tag/Organizations). organization-invitations-url: type: string title: organization-invitations-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations description: >- Link to the resource that enables you to [invite](#tag/Invites) new [users](#tag/Users) to this [organization](#tag/Organizations). organization-payments-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-url description: >- Link to the [payments](#tag/Payments) associated with this organization. example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments organization-bank-account-products-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-account-products-url description: >- Link to the [bank account](#tag/Bank-accounts) products owned by this [organization](#tag/Organization). example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/products organization-onboarding-applications-url: type: string title: organization-onboarding-applications-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications description: >- Link to the [Reliance onboarding](#tag/Reliance-onboarding). display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org organization-bank-accounts-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-bank-accounts-search-url description: >- Link to search [bank accounts](#tag/Bank-accounts) associated with this [organization](#tag/Organizations). example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/search organization-api-keys-url: type: string title: organization-api-keys-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys organization-live-access-url: type: string title: organization-live-access-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access description: >- Link to the resource that enables you to request live access. organization-webhooks-url: type: string title: organization-webhooks-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks description: Link to the endpoint which enables webhook creation. organization-workflows-url: type: string title: organization-workflows-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows description: >- Link to the onboarding [workflows](#tag/Workflows) configured for this [organization](#tag/Organizations). organization-bank-accounts-url: type: string title: organization-bank-accounts-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts description: >- Link to the [bank accounts](#tag/Bank-accounts) managed by this [organization](#tag/Organizations). available-roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url description: Link to the [role](#tag/Roles). example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA role-category: type: string required: - display-name - description - role-url title: role description: >- The subset of [roles](#tag/Roles) available to [members](#tag/Members) of this [organization](#tag/Organizations). title: available-roles can-decide-on-verifications?: type: boolean title: can-decide-on-verifications? description: >- Is this organization able to make manual decisions on verifications? organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). organization-payments-search-url: type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id - type: string x-allOf: - type: string - {} - type: object properties: organization-id: type: string format: '' title: organization-id required: true name: organization-id required: - organization-id title: organization-payments-search-url description: >- Link to search [payments](#tag/Payments) associated with this organization. example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/payments/search organization-individuals-url: type: string title: organization-individuals-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals organization-corporations-url: type: string title: organization-corporations-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations organization-legal-persons-url: type: string title: organization-legal-persons-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons description: >- Link to the [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-legal-persons-search-url: type: string title: organization-legal-persons-search-url example: >- /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons/search description: >- Link to search [legal persons](#tag/Legal-persons) grouped under this [organization](#tag/Organizations). organization-events-url: type: string title: organization-events-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events description: >- Link to the endpoint which lists an organization's events. required: - available-roles - can-decide-on-verifications? - display-name - organization-api-keys-url - organization-bank-accounts-url - organization-bank-account-products-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-payments-url - organization-url - organization-webhooks-url - organization-workflows-url - own-legal-person-url - organization-legal-persons-search-url - organization-bank-accounts-search-url - organization-payments-search-url title: organization additionalProperties: false roles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: The mutable display name for the Organisation maxLength: 64 example: Company Org description: type: string title: description role-url: type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id - type: string x-allOf: - type: string - {} - type: object properties: role-id: type: string format: '' title: role-id required: true name: role-id required: - role-id title: role-url description: Link to the [role](#tag/Roles). example: /v0/roles/re.ICAgICAgICAgcm9sZS1pZA role-category: type: string required: - display-name - description - role-url title: role title: roles description: Shows a collection of [roles](#tag/Roles). user: type: object properties: user-email: type: string title: user-email example: user@example.com description: The user's email address. user-url: type: string title: user-url example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. user-username: type: string title: user-username example: user@example.com description: The username. api-keys-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: api-keys-url description: Link to the user's [api keys](#tag/API-keys). example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys user-memberships-url: type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id - type: string x-allOf: - type: string - {} - type: object properties: user-id: type: string format: '' title: user-id required: true name: user-id required: - user-id title: user-memberships-url description: Link to the user's [memberships](#tag/Memberships). example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 required: - user-email - user-url - user-username - api-keys-url - user-memberships-url title: user description: Shows the associated [user](#tag/Users). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. required: - membership-url - membership-roles-url - organization - roles - user - created-at title: membership links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - memberships - links title: memberships-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. summary: List user memberships /v0/verifications/{verification-id}: get: tags: - Verifications description: Fetch the verification. parameters: - type: string required: true name: verification-id in: path responses: '200': schema: type: object properties: verification-profiles-url: type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id - type: string x-allOf: - type: string - {} - type: object properties: verification-id: type: string format: '' title: verification-id required: true name: verification-id required: - verification-id title: verification-profiles-url description: >- Get claims used in this [verification](#tag/Verifications) for all associated [legal persons](/docs/terms/legal-person). example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/profiles verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). verification-resources-url: type: string title: verification-resources-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/resources description: >- A link to the resources of a [verification](#tag/Verifications). updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url description: A contextual link to the [legal person](#tag/Legal-persons). example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. verification-checks-url: type: string title: verification-checks-url 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: type: string title: verification-risk-assessments-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/risk-assessments required: - created-at - legal-person-url - verification-status - verification-url - verification-checks-url title: verification description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get verification /v0/verifications/{verification-id}/profiles: get: tags: - Verifications description: >- GET a verification's profiles. A profile is the collection of claims used in a verification. parameters: - type: string required: true name: verification-id in: path responses: '200': schema: type: object properties: verification-subject-profile: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. current-claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: >- Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account title: current-claims description: >- The [claims](#tag/Claims) that were used in the verification for the profile. required: - display-name - legal-person-url - legal-person-type - current-claims title: The subject profile of this verification verification-related-party-profiles: type: array items: type: object properties: display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. current-claims: type: array items: type: object properties: {} required: - claim-type title: claim x-anyOf: - type: object properties: aeoi-entity-classification: title: aeoi-entity-classification enum: - passive-nfe - active-nfe - financial-institution type: string description: >- AEOI/CRS entity classification. Submit `financial-institution` if the entity is a financial institution (e.g. a bank, investment fund, or insurance company). Submit `active-nfe` if more than 50% of the entity's gross income is active (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant. claim-type: enum: - aeoi-entity-classification type: string required: - aeoi-entity-classification - claim-type title: aeoi-entity-classification - 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: alternative-number - type: object properties: annual-turnover: title: annual-turnover required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - annual-turnover type: string required: - annual-turnover - claim-type title: annual-turnover - type: object properties: balance-sheet-size: title: balance-sheet-size required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - balance-sheet-size type: string required: - balance-sheet-size - claim-type title: balance-sheet-size - type: object properties: business-address: type: object properties: {} required: - country-code title: business-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - business-address type: string required: - business-address - claim-type title: business-address - 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: business-description - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - business-email-address type: string required: - email-address - claim-type title: business-email-address - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. claim-type: enum: - business-industry type: string required: - business-industry - line-of-business - claim-type x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: business-industry - type: object properties: business-name: title: business-name type: string minLength: 1 claim-type: enum: - business-name type: string required: - business-name - claim-type title: business-name - type: object properties: business-owner?: type: boolean claim-type: enum: - business-owner type: string required: - business-owner? - claim-type title: business-owner - type: object properties: business-size: title: business-size type: string enum: - small - micro - large - medium claim-type: enum: - business-size type: string required: - business-size - claim-type title: business-size - type: object properties: business-start-date: title: business-start-date format: date type: string description: ISO 8601 formatted date. claim-type: enum: - business-start-date type: string required: - business-start-date - claim-type title: business-start-date - type: object properties: telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - business-telephone-number type: string required: - telephone-number - claim-type title: business-telephone-number - type: object properties: business-type: title: business-type type: string enum: - sole-trader claim-type: enum: - business-type type: string required: - business-type - claim-type title: business-type - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - business-website type: string required: - website-url - claim-type title: business-website - type: object properties: cash-payments?: type: boolean title: cash-payments? description: >- Attestation that funds generated from cash are (true) or are not (false) accepted. claim-type: enum: - cash-payments type: string required: - cash-payments? - claim-type title: cash-payments - type: object properties: client-money-protection-scheme: type: object properties: {} required: - scheme-registration-type title: client-money-protection-scheme x-anyOf: - type: object properties: scheme-registration-type: enum: - unregistered type: string title: unregistered required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - registering type: string title: registering required: - scheme-registration-type - type: object properties: scheme-registration-type: enum: - not-required type: string title: not-required required: - scheme-registration-type - type: object properties: scheme-details: title: scheme-details type: string minLength: 1 scheme-registration-type: enum: - registered type: string required: - scheme-details - scheme-registration-type title: registered claim-type: enum: - client-money-protection-scheme type: string required: - client-money-protection-scheme - claim-type title: client-money-protection-scheme - type: object properties: property-industries: title: property-industries claim-type: enum: - commercial-property-industries type: string required: - property-industries - claim-type title: commercial-property-industries x-oneOf: - type: object title: Not applicable properties: property-industries: type: string enum: - not-applicable required: - property-industries - type: object title: List of industries and lines of business properties: property-industries: type: array items: type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business x-allOf: - type: object properties: business-industry: title: business-industry enum: - health-and-wellness - entertainment-and-events - pharmaceuticals - automotive - creative-industries - construction-and-trades - retail - engineering - legal-services - agriculture-and-farming - finance-and-accounting - real-estate - manufacturing - other - hospitality - service-based-businesses - information-technology - transportation-and-logistics type: string example: information-technology line-of-business: title: line-of-business x-oneOf: - enum: null type: string example: software-development title: Predefined line of business description: > Must be selected according to business industry: | Business industry | Line of business | | ----------------- | ---------------- | | `agriculture-and-farming` | `small-scale-farming` | | | `gardening-services` | | `manufacturing` | `metal-casting` | | | `manufacturing-of-tobacco-products` | | | `handmade-crafts` | | | `manufacturing-of-jewelry` | | | `manufacturing-of-weapons-and-ammunition` | | | `small-scale-production` | | `real-estate` | `property-management` | | | `real-estate-agent` | | `service-based-businesses` | `consulting` | | | `cleaning` | | | `tutoring` | | `finance-and-accounting` | `financial-consulting` | | | `bookkeeping` | | `hospitality` | `cafes` | | | `restaurants` | | | `hotel-or-accommodation` | | `information-technology` | `it-consulting` | | | `web-design` | | | `software-development` | | `transportation-and-logistics` | `pilot` | | | `courier-services` | | | `taxi-or-private-hire` | | | `hgv-or-bus-driver` | | | `train-driver` | | `entertainment-and-events` | `performing-arts` | | | `party-entertainment` | | | `dj-services` | | | `event-planning` | | `health-and-wellness` | `massage-therapy` | | | `nutrition-coaching` | | | `beautician` | | | `hairdressing` | | | `personal-training` | | `pharmaceuticals` | `manufacturing-of-pharmaceuticals` | | | `sale-and-distribution-of-pharmaceuticals` | | `creative-industries` | `marketing-or-advertising` | | | `writing` | | | `photography` | | | `graphic-design` | | `construction-and-trades` | `plumbing` | | | `carpentry` | | | `electrical-work` | | `engineering` | `mechanical-engineering` | | | `civil-engineering` | | | `electrical-engineering` | | | `industrial-engineering` | | `retail` | `watches-and-jewelry` | | | `art` | | | `clothing` | | | `groceries` | | | `electronics` | | | `antiques` | | `automotive` | `sale-of-used-cars` | | | `sale-of-automotive-parts` | | | `car-repairs-and-detailing` | | `legal-services` | `legal-consulting` | | | `paralegal-services` | - type: string minLength: 1 title: Custom line of business description: >- User provided line of business that is only given when `business-industry` is `other`. required: - business-industry - line-of-business - {} title: industry+line-of-business uniqueItems: true required: - property-industries - type: object properties: commercial-property-percent: title: commercial-property-percent type: string enum: - commercial-0-percent - commercial-1-to-25-percent - commercial-51-to-99-percent - commercial-26-to-50-percent - commercial-100-percent claim-type: enum: - commercial-property-ratio type: string required: - commercial-property-percent - claim-type title: commercial-property-ratio - type: object properties: email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com claim-type: enum: - company-email-address type: string required: - email-address - claim-type title: company-email-address - 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: company-telephone-number - type: object properties: website-url: type: string x-allOf: - type: string - {} claim-type: enum: - company-website type: string required: - website-url - claim-type title: company-website - type: object properties: email-address: title: email-address type: string 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: contact-details - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: director - type: object properties: claim-type: enum: - employment type: string required: - employment-status - claim-type title: employment x-anyOf: - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - self-employed type: string required: - industry-of-occupation - employment-status title: self-employed - type: object properties: employment-status: enum: - retired type: string title: retired required: - employment-status - type: object properties: employment-status: enum: - unemployed type: string title: unemployed required: - employment-status - type: object properties: 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 - >- engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting - leisure-sport-and-tourism - adult-industry - antiques - transport-and-logistics - charity-and-not-for-profit-organizations - social-and-humanities-scientists - retail-of-jewellery - science-and-pharmaceuticals - retail-and-wholesale - social-care - accountancy-banking-and-finance - mining-and-drilling - marketing-advertising-and-pr - law - automotive-and-parts-dealers - 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 occupation: title: occupation enum: null type: string 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` | | `automotive-and-parts-dealers` | `any` | | `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` | | `engineering-and-manufacturing-pharma+jewellery+weaponry+tobacco+exotics+metal-casting` | `any` | | `adult-industry` | `any` | | `antiques` | `any` | | `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` | | `retail-of-jewellery` | `any` | | `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` | | `mining-and-drilling` | `any` | example: software-engineer employment-status: enum: - employed type: string required: - industry-of-occupation - employment-status title: employed - type: object properties: address-line-1: title: address-line-1 description: Building name or number, and street example: 10 High Street minLength: 1 maxLength: 150 city: title: city minLength: 1 maxLength: 50 country-code: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 address-line-2: title: address-line-2 description: >- Flat, floor, unit, suite, or additional information example: Flat 5A maxLength: 150 state: type: string title: state description: State, province, or region example: New York claim-type: enum: - entity-address type: string required: - address-line-1 - city - country-code - postal-code - claim-type title: entity-address - type: object properties: entity-name: title: entity-name type: string minLength: 1 claim-type: enum: - entity-name type: string required: - entity-name - claim-type title: entity-name - type: object properties: external-risk-rating: title: external-risk-rating type: string enum: - medium-risk - prohibited-risk - low-risk - high-risk claim-type: enum: - external-risk-rating type: string required: - external-risk-rating - claim-type title: external-risk-rating - type: object properties: fca-firm-reference-number: title: fca-firm-reference-number pattern: \d{6,7} description: >- The firm's unique reference number in the FCA's Financial Services Register. maxLength: 7 example: '123456' minLength: 6 claim-type: enum: - fca-fs-register-firm type: string required: - fca-firm-reference-number - claim-type title: fca-fs-register-firm - type: object properties: fca-individual-reference-number: title: fca-individual-reference-number pattern: '[A-Z]{3}\d{5}' example: ABC12345 description: >- The individual's unique reference number in the FCA's Financial Services Register. claim-type: enum: - fca-fs-register-individual type: string required: - fca-individual-reference-number - claim-type title: fca-fs-register-individual - type: object properties: fca-mutuals-register-number: title: fca-mutuals-register-number pattern: '[a-zA-Z0-9]{1,20}' type: string description: >- The society's unique identifier on the FCA Mutuals Register. maxLength: 20 example: 486CU minLength: 1 society-type: title: society-type enum: - working-mens-club - credit-union - building-society - co-operative-society - registered-society - friendly-society - community-benefit-society - benevolent-society - specially-authorised-society type: string description: >- The sub-classification of the society as it appears on the FCA Mutuals Register. Determines onboarding eligibility and drives conditional requirements — for example, `credit-union` and `building-society` require an FCA firm reference number, while `co-operative-society` does not. registration-act: title: registration-act enum: - credit-unions-act-1979 - >- co-operative-and-community-benefit-societies-act-2014 - friendly-societies-act-1992 - building-societies-act-1986 - >- co-operative-and-community-benefit-societies-act-northern-ireland-1969 - friendly-societies-act-1974 - >- the-credit-unions-northern-ireland-order-1985 type: string description: > The primary legislation under which the society is incorporated. Must be consistent with the `society-type` submitted: | Society type | Registration act | | ----------------- | ---------------- | | `benevolent-society` | `friendly-societies-act-1974` | | `building-society` | `building-societies-act-1986` | | `co-operative-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `community-benefit-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `credit-union` | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | | `credit-unions-act-1979` | | | `the-credit-unions-northern-ireland-order-1985` | | `friendly-society` | `friendly-societies-act-1974` | | | `friendly-societies-act-1992` | | `registered-society` | `co-operative-and-community-benefit-societies-act-2014` | | | `co-operative-and-community-benefit-societies-act-northern-ireland-1969` | | `specially-authorised-society` | `friendly-societies-act-1974` | | `working-mens-club` | `friendly-societies-act-1974` | claim-type: enum: - fca-mutuals-register type: string required: - fca-mutuals-register-number - society-type - registration-act - claim-type title: fca-mutuals-register - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - governing-body-member type: string required: - legal-person-url - claim-type title: governing-body-member - type: object properties: hmo-license?: type: boolean claim-type: enum: - hmo-license type: string required: - hmo-license? - claim-type title: hmo-license - type: object properties: hmo-verification: title: hmo-verification enum: - 'no' - 'yes' - not-applicable type: string description: >- Attestation of verifying licensing requirements of landlords for HMO properties. If no landlords have HMO properties, not-applicable should be chosen. claim-type: enum: - hmo-verification type: string required: - hmo-verification - claim-type title: hmo-verification - type: object properties: hmrc-registration: type: object properties: {} required: - hmrc-registration-type title: hmrc-registration x-anyOf: - type: object properties: hmrc-registration-type: enum: - unregistered type: string title: unregistered required: - hmrc-registration-type - type: object properties: hmrc-registration-number: title: hmrc-registration-number type: string minLength: 1 hmrc-registration-type: enum: - registered type: string required: - hmrc-registration-number - hmrc-registration-type title: registered claim-type: enum: - hmrc-register type: string required: - hmrc-registration - claim-type title: hmrc-register - type: object properties: date-of-birth: format: date type: string description: >- ISO 8601 formatted date. Date of birth cannot be more than 120 years ago and cannot be in the future title: date-of-birth given-name: title: given-name type: string minLength: 1 surname: title: surname type: string minLength: 1 middle-name: type: string claim-type: enum: - individual-identity type: string required: - date-of-birth - given-name - surname - claim-type title: individual-identity - type: object properties: income: title: income required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - individual-income type: string required: - income - claim-type title: individual-income - type: object properties: individual-purposes-of-account: type: array items: title: individual-purpose-of-account type: string enum: - short-term-investment - long-term-investment - savings - safeguarding - bills-and-repayment - staff-payroll - client-money - business-expenses - everyday-spending - receiving-payments - operational-spend uniqueItems: true claim-type: enum: - individual-purposes-of-account type: string required: - individual-purposes-of-account - claim-type title: individual-purposes-of-account - type: object properties: claim-type: enum: - individual-residence type: string required: - country-code - claim-type title: individual-residence x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - 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 - business-income - savings - salary-or-bonus - student-loans-or-bursary - retirement-or-pension - cryptocurrency - 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: individual-sources-of-funds - type: object properties: initial-deposit: title: initial-deposit required: - currency - value properties: currency: enum: - GBP type: string title: currency code example: GBP default: GBP value: type: string title: value description: >- The unsigned value as a decimal-formatted string example: '1000.00' default: '1.00' type: object additionalProperties: false claim-type: enum: - initial-deposit type: string required: - initial-deposit - claim-type title: initial-deposit - type: object properties: international-operations-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - international-operations-countries type: string required: - international-operations-countries - claim-type title: international-operations-countries - type: object properties: international-payments-countries: type: array items: title: country-code description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB 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. claim-type: enum: - international-payments-countries type: string required: - international-payments-countries - claim-type title: international-payments-countries - type: object properties: managed-property-count: type: integer format: int64 minimum: 0 claim-type: enum: - managed-properties type: string required: - managed-property-count - claim-type title: managed-properties - 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: mobile-number - type: object properties: nationality: title: nationality description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - nationality type: string required: - nationality - claim-type title: nationality - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). 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 required: - legal-person-url - {} title: nominal-person-with-significant-control - type: object properties: non-tenant-balance?: type: boolean claim-type: enum: - non-tenant-balance type: string required: - non-tenant-balance? - claim-type title: non-tenant-balance - type: object properties: number-of-employees: type: integer format: int64 minimum: 0 claim-type: enum: - number-of-employees type: string required: - number-of-employees - claim-type title: number-of-employees - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 x-allOf: - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: >- /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). ownership-percent: type: string format: '' title: ownership-percent description: >- The percentage ownership the legal person has of the corporation. 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 required: - legal-person-url - ownership-percent - {} title: person-with-significant-control - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. claim-type: enum: - properties-origins-of-deposits type: string required: - properties-origins-of-deposits - claim-type x-allOf: - type: object properties: properties-origins-of-deposits: type: array items: title: properties-origin-of-deposits type: string enum: - fees - tenant-rental-income - refunds - other - deposit-scheme-funds - funds-for-third-party-services uniqueItems: true other-origin: type: string minLength: 1 title: other-origin description: >- Description of 'other' deposit origins. Include if and only if 'other' is included in 'properties-origins-of-deposits'. required: - properties-origins-of-deposits - {} title: properties-origins-of-deposits - type: object properties: property-types: type: array items: title: property-type type: string enum: - hmo - residential - commercial - holiday-lets uniqueItems: true claim-type: enum: - property-types type: string required: - property-types - claim-type title: property-types - 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: purposes-of-account - 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: reliance-verification - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). role-titles: type: array items: title: role-title minLength: 1 maxLength: 50 example: Treasurer title: role-titles description: >- List of roles the individual holds on the entity e.g. ["Treasurer", "Honorary Secretary", "Chief Executive"] claim-type: enum: - role-titles type: string required: - legal-person-url - role-titles - claim-type title: role-titles - type: object properties: legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). claim-type: enum: - senior-manager-function-holder type: string required: - legal-person-url - claim-type title: senior-manager-function-holder - 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: sic-codes - 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: social-media - type: object properties: trading-name: type: string trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - sole-trader type: string required: - trading-name - trading-address - claim-type title: sole-trader - 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 - cryptocurrency - legal-settlement - family-or-gifted - loan - inheritance uniqueItems: true claim-type: enum: - sources-of-funds type: string required: - sources-of-funds - claim-type title: sources-of-funds - 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: tax-identification-number - type: object properties: tins-by-country: type: object additionalProperties: type: array items: title: tin type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} title: tins-by-country description: >- A map of tax identification numbers keyed by ISO 3166-1 alpha-2 country codes, where values are arrays of strings. TIN requirements vary by country — see below.

TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters; US TINs must additionally resolve to exactly 9 digits.

**TIN required** — a TIN must be provided for these countries. Exemptions are not accepted. Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required** in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.

**TIN required unless exempt** — a TIN should be provided where available. If a TIN cannot be provided, a valid exemption code must be submitted in `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`, and others designated as **TIN required unless exempt** in our [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).

**TIN not required** — no TIN or exemption code is required. These countries can be omitted in this field. Includes countries such as `GB` (except sole traders over £90K), and all countries designated as **TIN not required** in our [country list](/docs/guides/gjra-country-list#tin-not-required).

A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.

Example: `{ "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] }` example: >- { "DE": ["1234 5678 901"], "US": ["123-45-6789", "12-3456789"] } tin-exemptions-by-country: type: object additionalProperties: title: tin-exemption type: string enum: - jurisdiction-does-not-issue-tins - no-tin-required-by-domestic-law - unable-to-obtain-a-tin title: tin-exemptions-by-country description: >- A map of OECD exemption codes keyed by ISO 3166-1 alpha-2 country codes, where values are one of the accepted codes below. Only valid for countries in the **TIN required unless exempt** category. A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.

Example: `{ "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" }` example: >- { "AU": "unable-to-obtain-a-tin", "IN": "jurisdiction-does-not-issue-tins" } tin-exemption-explanations-by-country: type: object additionalProperties: type: string title: tin-exemption-explanation title: tin-exemption-explanations-by-country description: >- A map of free-text explanations keyed by ISO 3166-1 alpha-2 country codes, where values are strings. Required for any country using `unable-to-obtain-a-tin` in `tin-exemptions-by-country`.

Example: `{ "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."}` example: >- { "AU" : "Account holder recently relocated and has not yet been issued a TIN by the local tax authority."} claim-type: enum: - tax-identification-numbers-by-country type: string required: - tins-by-country - claim-type title: tax-identification-numbers-by-country - type: object properties: tax-residencies: type: array items: type: string title: tax-residencies description: |- Lists all countries where the legal person has tax residency as an array of ISO 3166-1 alpha-2 two-letter country codes. example: '["US", "DE"]' uniqueItems: true claim-type: enum: - tax-residencies type: string required: - tax-residencies - claim-type title: tax-residencies - type: object properties: tax-residency: title: tax-residency description: ISO 3166-1 alpha-2 two-letter country code. minLength: 2 maxLength: 2 example: GB claim-type: enum: - tax-residency type: string required: - tax-residency - claim-type title: tax-residency - type: object properties: trading-address: type: object properties: {} required: - country-code title: trading-address x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string required: - street-name - city - postal-code - country-code - country-code title: GB x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number claim-type: enum: - trading-address type: string required: - trading-address - claim-type title: trading-address - type: object properties: trading-name: type: string claim-type: enum: - trading-name type: string required: - trading-name - claim-type title: trading-name - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' claim-type: enum: - uk-company-register type: string required: - claim-type - country-code - entity-name - entity-registration-number - corporation-type title: uk-company-register x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number x-allOf: - type: object properties: entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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 date-of-incorporation: title: date-of-incorporation format: date type: string description: ISO 8601 formatted date. email-address: title: email-address type: string pattern: .+\@.+\..+ example: user@example.com telephone-number: title: telephone-number pattern: (\+[1-9])?\d{1,14} example: '+442012345678' required: - country-code - entity-name - entity-registration-number - corporation-type title: claim-registered-company x-anyOf: - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - IM type: string required: - street-name - city - postal-code - country-code - country-code title: IM x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GB type: string building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - street-name - city - postal-code - country-code - country-code title: GB - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - GG type: string required: - street-name - city - postal-code - country-code - country-code title: GG x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - type: object properties: street-name: title: street-name minLength: 1 maxLength: 50 city: title: city minLength: 1 maxLength: 50 postal-code: title: postal-code type: string maxLength: 10 example: NW16XE minLength: 1 country-code: enum: - JE type: string required: - street-name - city - postal-code - country-code - country-code title: JE x-anyOf: - type: object properties: building-name: title: building-name maxLength: 50 building-number: title: building-number maxLength: 50 required: - building-name - building-number title: both building-name and building-number - type: object properties: building-name: title: building-name maxLength: 50 required: - building-name title: only building-name - type: object properties: building-number: title: building-number maxLength: 50 required: - building-number title: only building-number - {} - 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 format: date type: string description: ISO 8601 formatted date. entity-name: title: entity-name type: string minLength: 1 entity-registration-number: type: string minLength: 1 title: entity-registration-number description: >- The entity number assigned by the local register. For UK companies that's the Companies House company number. 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: uk-financial-services-register - type: object properties: us-citizen?: type: boolean claim-type: enum: - us-citizen type: string required: - us-citizen? - claim-type title: us-citizen - type: object properties: vat-registration?: type: boolean claim-type: enum: - vat-registration type: string required: - vat-registration? - claim-type title: vat-registration - type: object properties: uk-domestic-account-number: type: string x-allOf: - type: string - {} title: uk-domestic-account-number pattern: ^[0-9]{8}$ description: A UK account number. maxLength: 8 example: '12345678' minLength: 8 uk-domestic-sort-code: title: uk-domestic-sort-code pattern: ^[0-9]{6}$ type: string description: A UK sort code. maxLength: 6 example: '123456' minLength: 6 claim-type: enum: - verified-bank-account type: string required: - uk-domestic-account-number - uk-domestic-sort-code - claim-type title: verified-bank-account title: current-claims description: >- The [claims](#tag/Claims) that were used in the verification for the profile. required: - display-name - legal-person-url - legal-person-type - current-claims title: profile title: The related profiles of this verification required: - verification-subject-profile - verification-related-party-profiles title: Verification profiles description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get verification profiles /v0/verifications/{verification-id}/resources: get: tags: - Verifications description: Yields details of the verification resources for this verification. parameters: - x-allOf: - type: integer format: int64 - minimum: 1 maximum: 201 maximum: 200 minimum: 1 name: page[size] required: false type: integer description: '' format: int64 in: query - in: query name: page[after] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - in: query name: page[before] description: A base64 encoded opaque string returned in paginated responses. type: string required: false format: byte - type: string required: true name: verification-id in: path responses: '200': schema: type: object properties: verification-url: type: string title: verification-url example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA description: A link to the [verification](#tag/Verifications). legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: A contextual link to the [legal person](#tag/Legal-persons). organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). verification-resources: type: array items: type: object properties: {} required: - verification-resource-type title: verification resource x-anyOf: - type: object properties: verification-resource-type: enum: - idv-check type: string verification-resource-id: type: string title: verification-resource-id description: Verification resource id example: vr.N7hwn54ASHCQGOdocxfQQQ idv-check-status: title: idv-check-status type: string enum: - pending - errored - expired - complete idv-check-url: type: string title: idv-check-url description: Link to the online ID&V check for that legal person. idv-check-expires-at: title: idv-check-expires-at format: date type: string description: ISO 8601 formatted date. display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity legal-person-url: type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id x-anyOf: - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id - type: string x-allOf: - type: string - {} - type: object properties: legal-person-id: type: string format: '' title: legal-person-id required: true name: legal-person-id required: - legal-person-id title: legal-person-url example: /v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA description: >- A contextual link to the [legal person](#tag/Legal-persons). required: - display-name - idv-check-expires-at - idv-check-status - idv-check-url - legal-person-url - verification-resource-id - verification-resource-type - verification-resource-type title: idv-check links: type: object properties: prev: type: string x-nullable: true next: type: string x-nullable: true required: - prev - next title: links required: - verification-url - legal-person-url - organization-url - verification-resources - links title: list-verification-resources-response description: '' '400': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get verification resources /v0/webhooks/{webhook-id}: get: tags: - Webhooks description: Fetch a webhook parameters: - type: string required: true name: webhook-id in: path responses: '200': schema: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. activate-webhook-url: type: string title: activate-webhook-url description: Activate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate deactivate-webhook-url: type: string title: deactivate-webhook-url description: Deactivate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. webhook-state: title: webhook-state enum: - inactive - active type: string description: The state of the webhook. created-by: type: string title: created-by example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). test-webhook-url: type: string title: test-webhook-url description: Test a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test webhook-url: type: string title: webhook-url example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA description: Link to the [webhook](#tag/Webhooks). webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ required: - organization-url - webhook-url - webhook-destination-url - test-webhook-url - created-at - webhook-state - activate-webhook-url - deactivate-webhook-url title: webhook description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' delete: tags: - Webhooks description: Delete a webhook parameters: - type: string required: true name: webhook-id in: path responses: '204': description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' patch: tags: - Webhooks description: Update a webhook parameters: - in: body name: request-update-webhook description: '' required: true schema: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook title: request-update-webhook - type: string required: true name: webhook-id in: path responses: '200': schema: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. activate-webhook-url: type: string title: activate-webhook-url description: Activate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate deactivate-webhook-url: type: string title: deactivate-webhook-url description: Deactivate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. webhook-state: title: webhook-state enum: - inactive - active type: string description: The state of the webhook. created-by: type: string title: created-by example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). test-webhook-url: type: string title: test-webhook-url description: Test a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test webhook-url: type: string title: webhook-url example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA description: Link to the [webhook](#tag/Webhooks). webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ required: - organization-url - webhook-url - webhook-destination-url - test-webhook-url - created-at - webhook-state - activate-webhook-url - deactivate-webhook-url title: webhook description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/webhooks/{webhook-id}/actions/activate: post: tags: - Webhooks description: Activate a webhook parameters: - type: string required: true name: webhook-id in: path responses: '200': schema: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. activate-webhook-url: type: string title: activate-webhook-url description: Activate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate deactivate-webhook-url: type: string title: deactivate-webhook-url description: Deactivate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. webhook-state: title: webhook-state enum: - inactive - active type: string description: The state of the webhook. created-by: type: string title: created-by example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). test-webhook-url: type: string title: test-webhook-url description: Test a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test webhook-url: type: string title: webhook-url example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA description: Link to the [webhook](#tag/Webhooks). webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ required: - organization-url - webhook-url - webhook-destination-url - test-webhook-url - created-at - webhook-state - activate-webhook-url - deactivate-webhook-url title: webhook description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/webhooks/{webhook-id}/actions/deactivate: post: tags: - Webhooks description: Deactivate a webhook parameters: - type: string required: true name: webhook-id in: path responses: '200': schema: type: object properties: webhook-description: title: webhook-description type: string minLength: 1 x-allOf: - title: non-empty-string type: string minLength: 1 - {} description: A description of the webhook example: Griffin API webhook updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. activate-webhook-url: type: string title: activate-webhook-url description: Activate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate deactivate-webhook-url: type: string title: deactivate-webhook-url description: Deactivate a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. webhook-state: title: webhook-state enum: - inactive - active type: string description: The state of the webhook. created-by: type: string title: created-by example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA description: Link to the user. organization-url: type: string title: organization-url example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA description: Link to the [organization](#tag/Organizations). test-webhook-url: type: string title: test-webhook-url description: Test a webhook example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test webhook-url: type: string title: webhook-url example: /v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA description: Link to the [webhook](#tag/Webhooks). webhook-destination-url: title: webhook-destination-url description: >- The callback URL of the webhook (HTTPS on port 443, public IP only) type: string example: https://example.com/griffin/webhook/ required: - organization-url - webhook-url - webhook-destination-url - test-webhook-url - created-at - webhook-state - activate-webhook-url - deactivate-webhook-url title: webhook description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' /v0/webhooks/{webhook-id}/actions/test: get: tags: - Webhooks description: Get the status of the latest test event parameters: - type: string required: true name: webhook-id in: path responses: '200': schema: type: object properties: {} required: - webhook-request-status x-anyOf: - type: object properties: webhook-request-status: enum: - default type: string updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. required: - webhook-request-status - updated-at - webhook-request-status title: default - type: object properties: webhook-request-status: enum: - complete type: string updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. 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-internal-error - webhook-invalid-response required: - webhook-request-status - updated-at - webhook-http-status - webhook-error-code - webhook-request-status title: complete title: webhook-test-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' post: tags: - Webhooks description: Send a test event to the webhook parameters: - type: string required: true name: webhook-id in: path responses: '201': headers: Location: type: string description: The URL to check the progress of the test schema: type: object properties: {} required: - webhook-request-status x-anyOf: - type: object properties: webhook-request-status: enum: - default type: string updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. required: - webhook-request-status - updated-at - webhook-request-status title: default - type: object properties: webhook-request-status: enum: - complete type: string updated-at: title: updated-at format: date-time type: string description: ISO 8601 formatted date-time. 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-internal-error - webhook-invalid-response required: - webhook-request-status - updated-at - webhook-http-status - webhook-error-code - webhook-request-status title: complete title: webhook-test-response description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '409': description: An existing test is in-flight '422': description: The webhook is not active /v0/workflows/{workflow-id}: get: tags: - Workflows description: Fetch the workflow. parameters: - type: string required: true name: workflow-id in: path responses: '200': schema: type: object properties: workflow-url: type: string title: workflow-url example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA description: A link to the [workflow](/docs/terms/workflow). display-name: type: string minLength: 1 title: display-name description: A human readable label for an entity description: type: string title: description legal-person-type: title: legal-person-type enum: - individual - corporation type: string description: >- Specifies if the legal person is an `individual` or a `corporation`. created-at: title: created-at format: date-time type: string description: ISO 8601 formatted date-time. disabled?: type: boolean title: disabled? description: >- When a workflow is disabled, no new verifications using that workflow can be created. required-claim-types: type: object additionalProperties: type: array items: title: claim-type type: string enum: - mobile-number - properties-origins-of-deposits - individual-identity - sole-trader - property-types - commercial-property-industries - uk-company-register - individual-income - business-website - initial-deposit - international-payments-countries - company-telephone-number - managed-properties - business-size - entity-address - person-with-significant-control - business-industry - tax-residencies - tenant-cash-payments - verified-bank-account - company-email-address - tax-residency - uk-financial-services-register - non-tenant-balance - business-description - hmrc-register - external-risk-rating - nfe-classification - vat-registration - entity-name - hmo-license - business-email-address - client-money-protection-scheme - fca-mutuals-register - individual-sources-of-funds - nominal-person-with-significant-control - hmo-verification - commercial-property-ratio - governing-body-member - business-address - employment - annual-turnover - purposes-of-account - sic-codes - international-operations-countries - balance-sheet-size - us-citizen - role-titles - sources-of-funds - senior-manager-function-holder - business-owner - business-telephone-number - individual-email-address - tax-identification-numbers-by-country - business-start-date - contact-details - reliance-verification - ultimate-beneficial-owner - aeoi-entity-classification - business-name - individual-purposes-of-account - nationality - trading-name - number-of-employees - social-media - trading-address - company-website - director - complex-business-structure - alternative-number - cash-payments - fca-fs-register-firm - tax-identification-number - fca-fs-register-individual - individual-residence - business-type uniqueItems: true title: required-claim-types description: |- A mapping of workflow-appropriate legal person types to claims that are required for each type. workflow-rules: type: array items: type: string enum: - allow-zero-directors - allow-missing-directors uniqueItems: true title: workflow-rules description: A list of special behaviours a workflow can possess. required: - workflow-url - display-name - description - legal-person-type - created-at - disabled? title: workflow description: '' '401': description: Requires an API key to continue headers: www-authenticate: type: string description: Returns `GriffinSession` if no valid authentication is found. '404': description: '' summary: Get workflow securityDefinitions: api-key-auth: type: apiKey in: header name: Authorization description: |- API token authentication. It should follow the format: `GriffinAPIKey g-test-MyKey-XXXXXXX` schemes: - https produces: - application/json x-id: - default swagger: '2.0'