🚧

In development

A legacy version of the Merchant Boarding API is live currently, however a new enhanced version is in development. For new consumers, it is highly recommended to use the new version of the API expected in Q3 2022.

Please note the API specification may change while it's in development

Owners Resource

Owners are used in the Ownership Entities resource. The address used for owners is always the personal address of the owner.

Mandatory Fields

AttributeTypeDescriptionExample / ENUMS
firstNamestringThe first name of the contactJohn
lastNamestringThe surname of the contactSmith
jobTitlestringThe job title/positon in the business of the contactStore Owner
phoneNumberobjectThe main telephone number for the contact, countryCode and subscriber{"countryCode": "44", "subscriber": "7724914829"}
streetLine1stringThe first line of the street address for the contactSomething Street
citystringThe city of the address for the contact Sheffield
zipCodestringThe zip/postal code of the address for the contactS10 2TS
countrystringThe country code of the address for the contactGBR ISO 3166 alpha-3 country code.
dateOfBirthdateThe date of birth of the owner/principal1975-03-01
nationalitystringThe nationality of the owner/principalGBR ISO 3166 alpha-3 country code.
ownerTypestringThe type of owner they are. See enum table below.OWNERS_PRINCIPALS
ownerPositionstringThe owner/principal position in the company. See enum table below.OWNER
ownershipPercentagestringThe ownership % of the company for the owner/principal25

Conditional

AttributeTypeDescriptionExample / ENUMS
houseNamestringThe house name of the address for the contact. Either houseName or houseNumber must be sentHouse
houseNumberstringThe house number of the address for the contact. Either houseName or houseNumber must be sent10
dateFromdateThe date from which the address was lived in when previousAddress = true2010-06-02
dateTodateThe date to which the address was lived in when previousAddress = true2019-06-02

Optional Fields

AttributeTypeDescriptionExample / ENUMS
middleNamestringThe second/middle name of the contactAdam
TitlestringThe title/salutation of the contactMr
streetLine2stringThe second line of the street address for the contactSomething Street
streetLine3stringThe third line of the street address for the contactSomething Street
countryCodeOfResidencystringThe country code of residence for the owner/principalGBR ISO 3166 alpha-3 country code.
sexstringThe birth sex of the owner/principalMALE
emailstringThe email address of the owner[email protected]

Owner Types

EnumerationDescriptionLink to resource
OWNERS_PRINCIPALSOwners or principalsOwner
MAIN_OWNER_PRINCIPALMain owner or principalOwner
BENEFICIAL_OWNERA beneficial ownerOwner

Owner Position

Enumeration
CEO
DIRECTOR
OWNER
SOLE_PROPRIETOR
TREASURER
OTHER
PARTNER
SECRETARY

Examples

Example Request

{
     "title": "Mr",
     "firstName": "John",
     "middleName": "Adam",
     "lastName": "Smith",
     "dateOfBirth": "2022-04-07",
     "nationality": "GBP",
     "countryCodeOfResidency": "GBR",
     "sex": "MALE",
     "jobTitle": "CEO",
     "ownerType": "OWNERS_PRINCIPALS",
     "ownerPosition": "CEO",
     "ownershipPercentage": "25",
     "email": "[email protected]",
     "phoneNumber": {
          "countryCode": "44",
          "subscriber": "7724914829"
     },
     "signatoryType": "SINGLE_SIGNATORY",
     "contractSigner": false,
     "addresses": [
          {
               "address": {
                    "buildingNumber": "10",
                    "buildingName": "House",
                    "line1": "Something Street",
                    "line2": "Something Street",
                    "line3": "Something Street",
                    "city": "Sheffield",
                    "postalCode": "TW2 7LD",
                    "country": "GBR"
               },
               "previousAddress": true,
               "dateFrom": "2022-04-07",
               "dateTo": "2022-04-07"
          }
     ]
}

Example Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "title": "Mr",
  "firstName": "John",
  "middleName": "Adam",
  "lastName": "Smith",
  "dateOfBirth": "2022-04-07",
  "nationality": "GBP",
  "countryCodeOfResidency": "GBR",
  "sex": "MALE",
  "jobTitle": "CEO",
  "ownerType": "OWNERS_PRINCIPALS",
  "ownerPosition": "CEO",
  "ownershipPercentage": "25",
  "email": "[email protected]",
  "phoneNumber": {
    "countryCode": "44",
    "subscriber": "7724914829"
  },
  "signatoryType": "SINGLE_SIGNATORY",
  "contractSigner": false,
  "addresses": [
    {
      "address": {
        "buildingNumber": "10",
        "buildingName": "House",
        "line1": "Something Street",
        "line2": "Something Street",
        "line3": "Something Street",
        "city": "Sheffield",
        "postalCode": "TW2 7LD",
        "country": "GBR"
      },
      "previousAddress": true,
      "dateFrom": "2022-04-07",
      "dateTo": "2022-04-07"
    }
  ]
}

Did this page help you?