Get Sandbox Access

Paybase Developer Centre

OverviewAPI GuidesGetting StartedRecipesGig Economy PlatformsSharing Economy PlatformsMarketplacesBlockchain BusinessesEscrowSandboxRolesRulesDue DiligenceCustomersAccountsBank AccountsCardsTransactionsIntroductionInboundGetting money into the systemTransaction ReferenceAccount ReferenceInternalOutboundEscrowSplit PaymentsRefundsStrong Customer Authentication3D Secure AuthenticationIntroductionCreate a cardCreate a transactionDocument UploadStatementsWebhooksErrorsPQLAPI ReferenceAccountCreate an accountRetrieve an accountTransition account statusList all accountsAnnotate an accountDelete annotation from an accountTag an accountDelete tag from an accountBank AccountCreate a bank accountRetrieve a bank accountUpdate a bank accountTransition bank account statusList all bank accountsAnnotate a bank accountDelete annotation from a bank accountTag a bank accountDelete tag from a bank accountCardCreate a cardRetrieve a cardUpdate a cardTransition card statusList all cardsAnnotate a cardDelete annotation from a cardTag a cardDelete tag from a cardCardholderCreate a cardholderRetrieve a cardholderUpdate a cardholderTransition cardholder statusList all cardholdersAnnotate a cardholderDelete annotation from a cardholderTag a cardholderDelete tag from a cardholderCreate an authentication tokenCheckCreate a checkCustomerIndividual CustomerCreate a customerRetrieve a customerUpdate a customerSole TraderCreate a customerRetrieve a customerUpdate a customerOrganisationCreate a CustomerRetrieve a CustomerUpdate a CustomerIncorporated BusinessCreate a customerRetrieve a customerUpdate a customerBusiness PersonAdd a business personRetrieve a business personUpdate a business personDelete a business personRetrieve a customerTransition state of a customerList all customersAnnotate a customerDelete annotation from a customerTag a customerRemove tag from a customerCreate an authentication tokenTouch a customerDocumentCreate a documentRetrieve a documentList Document TypesReferenceRetrieve a referenceStatementRetrieve a statementStatusRetrieve API statusTransactionCreate inbound transactionCreate internal transactionCreate outbound transactionRetrieve a transactionTransition transaction statusList all transactionsAnnotate a transactionDelete annotation from a transactionTag a transactionDelete tag from a transaction
API version: ba085a6

Tag a customerPATCH/v1/customer/{id}/tags

1
2
3
4
5
6
7
8
9
10
11
12
import { v1 } from '@paybase/client';

const client = v1('<- API Key ->', { sandbox: true });

const result = await client.tagCustomer({
  id: "customer/28958679-e8a8-47a8-967c-f979ae8509a2",
  tags: [
    42,
    foo,
    everything
  ]
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import json
import requests

requests.patch(
  "https://api-json.sandbox.paybase.io/v1/customer/customer/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/tags",
  data = json.dumps({
    "tags": [
      "42",
      "foo",
      "everything"
    ]
  }),
  headers = {
    "Content-Type": "application/json",
    "X-Token": "<X-Token goes here>"
  }
).json()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$client = new \GuzzleHttp\Client();
$client->request(
  "patch",
  "https://api-json.sandbox.paybase.io/v1/customer/customer/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/tags",
  [
    "body" => "{
      \"tags\": [
        \"42\",
        \"foo\",
        \"everything\"
      ]
    }",
    "headers" => [
      "Content-Type" => "application/json",
      "X-Token" => "<X-Token goes here>",
    ]
  ]
);

1
2
3
4
5
6
7
8
9
10
11
curl -X PATCH \
"https://api-json.sandbox.paybase.io/v1/customer/customer/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/tags"  -H "Content-Type: application/json" \
  -H "X-Token: <X-Token goes here>" \
  -d '{
    "tags": [
      "42",
      "foo",
      "everything"
    ]
  }'

Request

FieldDescription
idURI Param
string

The unique identifier of the entity.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658 or account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

tagsrequired
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

Response

FieldDescription
incorporatedBusiness.id
string

The unique identifier of the customer object.

Format

customer/_uuid_

e.g. customer/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

incorporatedBusiness.createdAt
date

The timestamp in UTC at which the customer was created.

incorporatedBusiness.updatedAt
date

The timestamp in UTC at which the customer was last updated.

incorporatedBusiness.activeAt
date

The timestamp in UTC at which the customer was last considered active.

incorporatedBusiness.stateId
enum

The current state of the customer.

enum

  • PENDING - A customer in the PENDING state is present on the system, but is not yet ENABLED. Use this state when you wish to add a customer to the system, but don't want them to interact with it straight away.

  • ENABLED - The customer has been created and can start transacting if the required level of due diligence has been achieved.

  • DISABLED - The customer is temporarily disabled and cannot make any debit transactions from their account. e.g Withdrawals

  • LOCKED - The customer has been locked by Paybase and cannot transact until enabled again by Paybase.

  • CLOSING - The customer has been flagged for closing by Paybase and will be terminated within 90 days. Only withdrawals to an existing bankAaccount can be processed in this state.

  • TERMINATED - The customer has been terminated by Paybase and cannot interact with the system or trasition to another state.

incorporatedBusiness.annotations
object<string, string>

A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.

incorporatedBusiness.tags
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

incorporatedBusiness.terms.acceptedAt
date

The timestamp in UTC at which the Terms were accepted.

incorporatedBusiness.terms.revision
string

Version name or number of the Terms that were accepted.

incorporatedBusiness.cddLevel
enum

The level of customer due diligence achieved by this customer.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

Due diligence checks are performed asynchronously by our system. Therefore, at creation the cddLevel of a customer might be ZERO but will automatically increase as checks are processed by our system. In some instances, an automated check might fail and you will be required to provided additional information for the customer.

You can use to customer_cdd_level_changed webhook to get notified on changes in the cddLevel of a customer or the check_failed webhook for notifications on failed checks.

incorporatedBusiness.targetCDDLevel
enum

The targetCDDLevel for a customer depends on their role and is the level to which our system will attempt to verify a customer. The information required for each level differs and would have been provided to you at the time of onboarding.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

incorporatedBusiness.companyNumber
string

The full company registration number as it appears on the relevant register.

incorporatedBusiness.businessPersons
array<BusinessPerson>

A list of business persons associated with the customer.

incorporatedBusiness.roleId
string

The unique identifier of the role associated with the customer.

Format

role/_uuid_

e.g. role/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

incorporatedBusiness.profile.registeredName
string

The full registered name of the company as it appears on the relevant register (such as Companies House in the UK).

incorporatedBusiness.profile.tradingName
string

The trading name of the company if differnt from the registeredName.

incorporatedBusiness.profile.email
string

The email address of the customer.

incorporatedBusiness.profile.phoneNumber
string

The phone number of the customer including country code with a 00 or + prefix.

e.g 00447712345678 or +447712345678 for a UK phone number

incorporatedBusiness.profile.industry
string

The industry in which the business operates. You do not have to provide this as we will automatically fetch and return the industry based on the companyNumber.

incorporatedBusiness.profile.url
string

The URL for the business website, including the http/s scheme.

Format

e.g. https://paybase.io/

incorporatedBusiness.profile.taxCountryISO
string

The country where the business is incorporated.

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

incorporatedBusiness.profile.registeredAddress.flatNumber
string

Flat number.

incorporatedBusiness.profile.registeredAddress.houseNameNumber
string

House name or number. If the address has both, include both in the string.

incorporatedBusiness.profile.registeredAddress.street
string

Street name.

incorporatedBusiness.profile.registeredAddress.townCity
string

Town or city.

incorporatedBusiness.profile.registeredAddress.region
string

Region/County/State/Province.

incorporatedBusiness.profile.registeredAddress.postalCode
string

Postal Code or ZIP.

incorporatedBusiness.profile.registeredAddress.countryISO
string

Country code

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

incorporatedBusiness.profile.tradingAddress.flatNumber
string

Flat number.

incorporatedBusiness.profile.tradingAddress.houseNameNumber
string

House name or number. If the address has both, include both in the string.

incorporatedBusiness.profile.tradingAddress.street
string

Street name.

incorporatedBusiness.profile.tradingAddress.townCity
string

Town or city.

incorporatedBusiness.profile.tradingAddress.region
string

Region/County/State/Province.

incorporatedBusiness.profile.tradingAddress.postalCode
string

Postal Code or ZIP.

incorporatedBusiness.profile.tradingAddress.countryISO
string

Country code

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

incorporatedBusiness.profile.orgChart
string

A description of the incorporated business and its legal holding structure. Depending on the target due diligence level set for your customers, we will need to understand who the beneficial owners of the business are. You can also upload a document on the customer profile with this information.

incorporatedBusiness.profile.incorporatedDate
date

Date of incoporation of the business, in UTC.

Input Date Formats

incorporatedBusiness.profile.accountPurpose
enum

A description of what the account will be used for.

enum

FREELANCE, GAMING, SALARY, INVESTMENT, OTHER, PURCHASE_GOODS_AND_SERVICES, SELL_GOODS_AND_SERVICES, SAVINGS, FRIENDS_AND_FAMILY,

incorporatedBusiness.profile.businessDescription
string

A short description of the activities of the business. Required if a business url is not provided.

incorporatedBusiness.preferredInstruments.card.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

incorporatedBusiness.preferredInstruments.card.updatedAt
date

The timestamp in UTC at which the entity was last updated.

incorporatedBusiness.preferredInstruments.bankAccount.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

incorporatedBusiness.preferredInstruments.bankAccount.updatedAt
date

The timestamp in UTC at which the entity was last updated.

individual.id
string

The unique identifier of the customer object.

Format

customer/_uuid_

e.g. customer/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

individual.createdAt
date

The timestamp in UTC at which the customer was created.

individual.updatedAt
date

The timestamp in UTC at which the customer was last updated.

individual.activeAt
date

The timestamp in UTC at which the customer was last considered active.

individual.stateId
enum

The current state of the customer.

enum

  • PENDING - A customer in the PENDING state is present on the system, but is not yet ENABLED. Use this state when you wish to add a customer to the system, but don't want them to interact with it straight away.

  • ENABLED - The customer has been created and can start transacting if the required level of due diligence has been achieved.

  • DISABLED - The customer is temporarily disabled and cannot make any debit transactions from their account. e.g Withdrawals

  • LOCKED - The customer has been locked by Paybase and cannot transact until enabled again by Paybase.

  • CLOSING - The customer has been flagged for closing by Paybase and will be terminated within 90 days. Only withdrawals to an existing bankAaccount can be processed in this state.

  • TERMINATED - The customer has been terminated by Paybase and cannot interact with the system or trasition to another state.

individual.annotations
object<string, string>

A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.

individual.tags
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

individual.terms.acceptedAt
date

The timestamp in UTC at which the Terms were accepted.

individual.terms.revision
string

Version name or number of the Terms that were accepted.

individual.cddLevel
enum

The level of customer due diligence achieved by this customer.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

Due diligence checks are performed asynchronously by our system. Therefore, at creation the cddLevel of a customer might be ZERO but will automatically increase as checks are processed by our system. In some instances, an automated check might fail and you will be required to provided additional information for the customer.

You can use to customer_cdd_level_changed webhook to get notified on changes in the cddLevel of a customer or the check_failed webhook for notifications on failed checks.

individual.targetCDDLevel
enum

The targetCDDLevel for a customer depends on their role and is the level to which our system will attempt to verify a customer. The information required for each level differs and would have been provided to you at the time of onboarding.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

individual.roleId
string

The unique identifier of the role.

Format

role/_uuid_

e.g. role/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

individual.profile.email
string

The email address of the individual.

Email address is one of the parameters we use to determine if an individual customer is unique.

individual.profile.phoneNumber
string

The phone number of the individual including country code with a 00 or + prefix.

e.g 00447712345678 or +447712345678 for a UK phone number

individual.profile.residentialAddress.flatNumber
string

Flat number.

individual.profile.residentialAddress.houseNameNumber
string

House name or number. If the address has both, include both in the string.

individual.profile.residentialAddress.street
string

Street name.

individual.profile.residentialAddress.townCity
string

Town or city.

individual.profile.residentialAddress.region
string

Region/County/State/Province.

individual.profile.residentialAddress.postalCode
string

Postal Code or ZIP.

individual.profile.residentialAddress.countryISO
string

Country code

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

individual.profile.firstName
string

The first name of the individual.

individual.profile.lastName
string

The last name of the individual.

individual.profile.dob
date

The date of the birth of the individual, in UTC.

Input Date Formats

individual.profile.accountPurpose
enum

A description of what the account will be used for.

enum

FREELANCE, GAMING, SALARY, INVESTMENT, OTHER, PURCHASE_GOODS_AND_SERVICES, SELL_GOODS_AND_SERVICES, SAVINGS, FRIENDS_AND_FAMILY,

individual.preferredInstruments.card.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

individual.preferredInstruments.card.updatedAt
date

The timestamp in UTC at which the entity was last updated.

individual.preferredInstruments.bankAccount.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

individual.preferredInstruments.bankAccount.updatedAt
date

The timestamp in UTC at which the entity was last updated.

soleTrader.id
string

The unique identifier of the customer object.

Format

customer/_uuid_

e.g. customer/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

soleTrader.createdAt
date

The timestamp in UTC at which the customer was created.

soleTrader.updatedAt
date

The timestamp in UTC at which the customer was last updated.

soleTrader.activeAt
date

The timestamp in UTC at which the customer was last considered active.

soleTrader.stateId
enum

The current state of the customer.

enum

  • PENDING - A customer in the PENDING state is present on the system, but is not yet ENABLED. Use this state when you wish to add a customer to the system, but don't want them to interact with it straight away.

  • ENABLED - The customer has been created and can start transacting if the required level of due diligence has been achieved.

  • DISABLED - The customer is temporarily disabled and cannot make any debit transactions from their account. e.g Withdrawals

  • LOCKED - The customer has been locked by Paybase and cannot transact until enabled again by Paybase.

  • CLOSING - The customer has been flagged for closing by Paybase and will be terminated within 90 days. Only withdrawals to an existing bankAaccount can be processed in this state.

  • TERMINATED - The customer has been terminated by Paybase and cannot interact with the system or trasition to another state.

soleTrader.annotations
object<string, string>

A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.

soleTrader.tags
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

soleTrader.terms.acceptedAt
date

The timestamp in UTC at which the Terms were accepted.

soleTrader.terms.revision
string

Version name or number of the Terms that were accepted.

soleTrader.cddLevel
enum

The level of customer due diligence achieved by this customer.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

Due diligence checks are performed asynchronously by our system. Therefore, at creation the cddLevel of a customer might be ZERO but will automatically increase as checks are processed by our system. In some instances, an automated check might fail and you will be required to provided additional information for the customer.

You can use to customer_cdd_level_changed webhook to get notified on changes in the cddLevel of a customer or the check_failed webhook for notifications on failed checks.

soleTrader.targetCDDLevel
enum

The targetCDDLevel for a customer depends on their role and is the level to which our system will attempt to verify a customer. The information required for each level differs and would have been provided to you at the time of onboarding.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

soleTrader.roleId
string

The unique identifier of the role.

Format

role/_uuid_

e.g. role/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

soleTrader.profile.email
string

The email address of the customer.

Email address is one of the parameters we use to determine if a customer is unique.

soleTrader.profile.phoneNumber
string

The phone number of the customer including country code with a 00 or + prefix.

e.g 00447712345678 or +447712345678 for a UK phone number

soleTrader.profile.industry
string

The industry in which the sole trader operates.

soleTrader.profile.residentialAddress.flatNumber
string

Flat number.

soleTrader.profile.residentialAddress.houseNameNumber
string

House name or number. If the address has both, include both in the string.

soleTrader.profile.residentialAddress.street
string

Street name.

soleTrader.profile.residentialAddress.townCity
string

Town or city.

soleTrader.profile.residentialAddress.region
string

Region/County/State/Province.

soleTrader.profile.residentialAddress.postalCode
string

Postal Code or ZIP.

soleTrader.profile.residentialAddress.countryISO
string

Country code

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

soleTrader.profile.tradingName
string

The trading name of the sole trader if different to their given name.

soleTrader.profile.firstName
string

The first name of the customer.

soleTrader.profile.lastName
string

The last name of the customer.

soleTrader.profile.url
string

The URL of the sole trader's website, including the http/s scheme.

Format

e.g. https://paybase.io/

soleTrader.profile.dob
date

The date of the birth of the customer, in UTC.

Input Date Formats

soleTrader.profile.accountPurpose
enum

A description of what the account will be used for.

enum

FREELANCE, GAMING, SALARY, INVESTMENT, OTHER, PURCHASE_GOODS_AND_SERVICES, SELL_GOODS_AND_SERVICES, SAVINGS, FRIENDS_AND_FAMILY,

soleTrader.profile.occupation
enum

The occupation of the Customer

enum

ADMINISTRATION, AGRICULTURE_FOOD_NATURAL_RESOURCES, ARCHITECTURE_CONSTRUCTION, ARTS_AUDIO_VIDEO_COMMUNICATIONS, BUSINESS_MANAGEMENT, CUSTOMER_SERVICE, EDUCATION_TRAINING, EMERGENCY_SERVICES, FINANCIAL_SERVICES, GOVERNMENT_NGO, HEALTH_BEAUTY, HOSPITALITY_TOURISM, HUMAN_RESOURCES, INFORMATION_TECHNOLOGY, JOURNALISM_WRITING, LAW, MAINTENANCE_TRADESPERSON, MANUFACTURING, MARKETING_SALES, PRODUCT_DESIGN, SCIENCE_TECH_ENGINEERING_MATH, TRANSPORTATION_LOGISTICS, STUDENT, OTHER

soleTrader.preferredInstruments.card.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

soleTrader.preferredInstruments.card.updatedAt
date

The timestamp in UTC at which the entity was last updated.

soleTrader.preferredInstruments.bankAccount.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

soleTrader.preferredInstruments.bankAccount.updatedAt
date

The timestamp in UTC at which the entity was last updated.

organisation.id
string

The unique identifier of the customer object.

Format

customer/_uuid_

e.g. customer/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

organisation.createdAt
date

The timestamp in UTC at which the customer was created.

organisation.updatedAt
date

The timestamp in UTC at which the customer was last updated.

organisation.activeAt
date

The timestamp in UTC at which the customer was last considered active.

organisation.stateId
enum

The current state of the customer.

enum

  • PENDING - A customer in the PENDING state is present on the system, but is not yet ENABLED. Use this state when you wish to add a customer to the system, but don't want them to interact with it straight away.

  • ENABLED - The customer has been created and can start transacting if the required level of due diligence has been achieved.

  • DISABLED - The customer is temporarily disabled and cannot make any debit transactions from their account. e.g Withdrawals

  • LOCKED - The customer has been locked by Paybase and cannot transact until enabled again by Paybase.

  • CLOSING - The customer has been flagged for closing by Paybase and will be terminated within 90 days. Only withdrawals to an existing bankAaccount can be processed in this state.

  • TERMINATED - The customer has been terminated by Paybase and cannot interact with the system or trasition to another state.

organisation.annotations
object<string, string>

A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.

organisation.tags
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

organisation.terms.acceptedAt
date

The timestamp in UTC at which the Terms were accepted.

organisation.terms.revision
string

Version name or number of the Terms that were accepted.

organisation.cddLevel
enum

The level of customer due diligence achieved by this customer.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

Due diligence checks are performed asynchronously by our system. Therefore, at creation the cddLevel of a customer might be ZERO but will automatically increase as checks are processed by our system. In some instances, an automated check might fail and you will be required to provided additional information for the customer.

You can use to customer_cdd_level_changed webhook to get notified on changes in the cddLevel of a customer or the check_failed webhook for notifications on failed checks.

organisation.targetCDDLevel
enum

The targetCDDLevel for a customer depends on their role and is the level to which our system will attempt to verify a customer. The information required for each level differs and would have been provided to you at the time of onboarding.

enum

ZERO, ONE, TWO, THREE, FOUR, FIVE

organisation.roleId
string

The unique identifier of the role associated with the customer.

Format

role/_uuid_

e.g. role/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

organisation.profile.name
string

The name of the customer.

organisation.profile.phoneNumber
string

The phone number of the customer including country code with a 00 or + prefix.

e.g 00447712345678 or +447712345678 for a UK phone number

organisation.profile.email
string

The email address of the customer.

organisation.profile.registeredNumber
string

The registration number of the customer if the organisation is registered with a government registry.

organisation.profile.registeredAddress.flatNumber
string

Flat number.

organisation.profile.registeredAddress.houseNameNumber
string

House name or number. If the address has both, include both in the string.

organisation.profile.registeredAddress.street
string

Street name.

organisation.profile.registeredAddress.townCity
string

Town or city.

organisation.profile.registeredAddress.region
string

Region/County/State/Province.

organisation.profile.registeredAddress.postalCode
string

Postal Code or ZIP.

organisation.profile.registeredAddress.countryISO
string

Country code

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

organisation.profile.supplementaryInformation
object<string, string>

Additional information on the customer as required for verification purposes. This will have been communicated to you at the time of onboarding.

Format

A hash map of string key value pairs.

e.g. activity: sale of clothes for charity

organisation.profile.accountPurpose
enum

A description of what the account will be used for.

enum

FREELANCE, GAMING, SALARY, INVESTMENT, OTHER, PURCHASE_GOODS_AND_SERVICES, SELL_GOODS_AND_SERVICES, SAVINGS, FRIENDS_AND_FAMILY,

organisation.profile.businessDescription
string

A short description of the activities of the business. Required if a business url is not provided.

organisation.preferredInstruments.card.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

organisation.preferredInstruments.card.updatedAt
date

The timestamp in UTC at which the entity was last updated.

organisation.preferredInstruments.bankAccount.id
string

The unique identifier of the card or bank_account that is the preferredInstrument.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

bank_account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

organisation.preferredInstruments.bankAccount.updatedAt
date

The timestamp in UTC at which the entity was last updated.