swagger: '2.0'
info:
title: The Griffin API keys Claims API
version: ''
description: "## Introduction\n\nThe Griffin API is based on [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\nIt 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.\n\nOur API deviates from strict RESTful principles if it makes sense to do so, such as when we enforce tighter access controls around certain operations.\nFor 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.\n\nAnyone 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).\n\nNew to Griffin? Check out our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Navigation\n\nOur API is designed to be navigated programmatically. When you request any resource, you will find the URLs for related resources in the response body.\n\nThe 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.\n\nTo bootstrap the navigation process, request the [index](#tag/Navigation/paths/~1v0~1index/get) endpoint: the response will contain your `organization-url`.\n\nFor a walkthrough, see our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Pagination\n\nOur 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)).\nBy 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.\n\n### Change page size\n\nYou can request a different number of results (between 1 and 200, inclusive) by using the `page[size]` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?page[size]=100\n```\n\n### Navigating between pages\n\nList responses will include a `links` object with `prev` and `next` attributes, as shown below.\nPerform a GET request to the value of the attribute to fetch the previous/next page of results.\n\n```\n{\n \"accounts\": [\n // ...\n ],\n \"links\": {\n \"prev\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[before]=djE6WxSPxfYUTnCU9XtWzj9gGA\",\n \"next\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[after]=djE6aw79PXZySUOL16LD8HRJ3A\"\n }\n}\n\n```\nIf there is no previous or next page available, the value of the attribute will be null.\n\nAny other query parameters included in the initial request will also be included in the response payload's links.\nIf you want to change parameters (see [filtering and sorting](#section/Filtering-and-sorting)), request the first page and follow the links from there.\n\n## Filtering and sorting\n\n### Sort results\n\nBy default, resources will be listed in descending order, usually based on the `created-at` attribute.\nYou can change the sorting behaviour of a list of results by using the `sort` query parameter.\n\nFor example, to list bank accounts in ascending order (oldest first):\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=created-at\n```\n\nTo _explicitly_ sort in descending order (newest first), prefix the sort attribute with `-`:\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=-created-at\n```\n\n### Filter results\n\nSome list APIs allow you to filter the results.\nFilters are expressed as nested data structures encoded into query parameters.\nFor example, you can list bank accounts that are in either the `opening` or `open` state with:\n\n```\nGET /v0/organizations/:id/bank/accounts?filter[account-status][in][]=opening&filter[account-status][in][]=open\n```\n\nSimilarly, you can list legal persons with a specific `application-status`:\n\n```\nGET /v0/organizations/:id/legal-persons?filter[application-status][eq]=accepted\n```\n\n### Include resources\n\nSome list APIs allow you to include associated resources in the response, reducing the number of requests needed to fetch related data.\nFor instance, when listing bank accounts, you can include each bank account's beneficiary legal person by using the `include` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?include=beneficiary\n```\n\nThe response returns the usual list of bank accounts, but it will also have an `included` object with a `legal-persons` attribute:\n\n```\n{\n \"accounts\": [\n // ...\n ],\n \"links\": {\n // ...\n }\n \"included\": {\n \"legal-persons\": [\n // ...\n ]\n }\n}\n```\n\nCheck the documentation for each list API to see all options for sorting and filtering\n\n## Request limits\n\nEach 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.\n\n## Versioning\n\nThe Griffin API is versioned via a prefix in the URL.\nThe current version is v0.\nAn example endpoint is: https://api.griffin.com/v0/index.\n\nWe will not break your integration with a particular version for as long as we support that version.\nIf we release a new version, you will have 12 months to upgrade to it."
host: api.griffin.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- api-key-auth: []
tags:
- 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.
paths:
/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/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`\n if the entity is a financial institution (e.g. a bank, investment fund, or insurance company).\n Submit `active-nfe` if more than 50% of the entity's gross income is active\n (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used\n to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive\n (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\n `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\n `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)\n 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\n `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\n `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.\n Determines onboarding eligibility and drives conditional requirements —\n for example, `credit-union` and `building-society` require an FCA firm reference number,\n 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\n for HMO properties. If no landlords have HMO properties, not-applicable\n 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\n from UK accounts that are, in full or in part,\n funded from international sources. If the\n account does not receive payments from\n internationally-funded sources, then leave\n 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,\n where values are arrays of strings. TIN requirements vary by country — see below.
\n TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once\n separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters;\n US TINs must additionally resolve to exactly 9 digits.
\n **TIN required** — a TIN must be provided for these countries. Exemptions are not accepted.\n Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required**\n in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual\n revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.
\n **TIN required unless exempt** — a TIN should be provided where available.\n If a TIN cannot be provided, a valid exemption code must be submitted in\n `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`,\n and others designated as **TIN required unless exempt** in our\n [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).
\n **TIN not required** — no TIN or exemption code is required. These countries can be\n omitted in this field.\n Includes countries such as `GB` (except sole traders over £90K), and all countries\n designated as **TIN not required** in our\n [country list](/docs/guides/gjra-country-list#tin-not-required).
\n A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.
\n Example:\n `{ \"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,\n where values are one of the accepted codes below. Only valid for countries\n in the **TIN required unless exempt** category.\n A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.
\n Example:\n `{ \"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,\n where values are strings. Required for any country using `unable-to-obtain-a-tin`\n in `tin-exemptions-by-country`.
\n Example:\n `{ \"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\n 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`\n if the entity is a financial institution (e.g. a bank, investment fund, or insurance company).\n Submit `active-nfe` if more than 50% of the entity's gross income is active\n (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used\n to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive\n (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\n `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\n `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)\n 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\n `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\n `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.\n Determines onboarding eligibility and drives conditional requirements —\n for example, `credit-union` and `building-society` require an FCA firm reference number,\n 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\n for HMO properties. If no landlords have HMO properties, not-applicable\n 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\n from UK accounts that are, in full or in part,\n funded from international sources. If the\n account does not receive payments from\n internationally-funded sources, then leave\n 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,\n where values are arrays of strings. TIN requirements vary by country — see below.
\n TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once\n separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters;\n US TINs must additionally resolve to exactly 9 digits.
\n **TIN required** — a TIN must be provided for these countries. Exemptions are not accepted.\n Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required**\n in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual\n revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.
\n **TIN required unless exempt** — a TIN should be provided where available.\n If a TIN cannot be provided, a valid exemption code must be submitted in\n `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`,\n and others designated as **TIN required unless exempt** in our\n [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).
\n **TIN not required** — no TIN or exemption code is required. These countries can be\n omitted in this field.\n Includes countries such as `GB` (except sole traders over £90K), and all countries\n designated as **TIN not required** in our\n [country list](/docs/guides/gjra-country-list#tin-not-required).
\n A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.
\n Example:\n `{ \"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,\n where values are one of the accepted codes below. Only valid for countries\n in the **TIN required unless exempt** category.\n A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.
\n Example:\n `{ \"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,\n where values are strings. Required for any country using `unable-to-obtain-a-tin`\n in `tin-exemptions-by-country`.
\n Example:\n `{ \"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\n 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`\n if the entity is a financial institution (e.g. a bank, investment fund, or insurance company).\n Submit `active-nfe` if more than 50% of the entity's gross income is active\n (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used\n to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive\n (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\n `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\n `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)\n 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\n `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\n `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.\n Determines onboarding eligibility and drives conditional requirements —\n for example, `credit-union` and `building-society` require an FCA firm reference number,\n 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\n for HMO properties. If no landlords have HMO properties, not-applicable\n 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\n from UK accounts that are, in full or in part,\n funded from international sources. If the\n account does not receive payments from\n internationally-funded sources, then leave\n 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,\n where values are arrays of strings. TIN requirements vary by country — see below.
\n TINs may be submitted with or without separators (spaces, hyphens, dots, slashes, parentheses). Once\n separators are stripped and letters upper-cased, a TIN must be 5–20 alphanumeric characters;\n US TINs must additionally resolve to exactly 9 digits.
\n **TIN required** — a TIN must be provided for these countries. Exemptions are not accepted.\n Includes countries such as `US`, `DE`, `FR`, `CN`, and others designated as **TIN required**\n in our [country list](/docs/guides/gjra-country-list#tin-required). Additionally: `GB` is only required for sole traders with annual\n revenue over £90,000, and `US` is required for all US citizens regardless of tax residency.
\n **TIN required unless exempt** — a TIN should be provided where available.\n If a TIN cannot be provided, a valid exemption code must be submitted in\n `tin-exemptions-by-country` instead. Includes countries such as `AU`, `IN`, `JP`, `MX`,\n and others designated as **TIN required unless exempt** in our\n [country list](/docs/guides/gjra-country-list#tin-required-unless-exempt).
\n **TIN not required** — no TIN or exemption code is required. These countries can be\n omitted in this field.\n Includes countries such as `GB` (except sole traders over £90K), and all countries\n designated as **TIN not required** in our\n [country list](/docs/guides/gjra-country-list#tin-not-required).
\n A country must not appear in both `tins-by-country` and `tin-exemptions-by-country`.
\n Example:\n `{ \"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,\n where values are one of the accepted codes below. Only valid for countries\n in the **TIN required unless exempt** category.\n A country must not appear in both `tin-exemptions-by-country` and `tins-by-country`.
\n Example:\n `{ \"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,\n where values are strings. Required for any country using `unable-to-obtain-a-tin`\n in `tin-exemptions-by-country`.
\n Example:\n `{ \"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\n 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
securityDefinitions:
api-key-auth:
type: apiKey
in: header
name: Authorization
description: 'API token authentication.
It should follow the format: `GriffinAPIKey g-test-MyKey-XXXXXXX`'
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
x-id:
- default