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: a0406ac

Add a business personPOST/v1/customer/{customerId}/persons

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import { v1 } from '@paybase/client';

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

const result = await client.addBusinessPerson({
  customerId: "customer/28958679-e8a8-47a8-967c-f979ae8509a2",
  profile: {
    firstName: "Mariana",
    lastName: "Gutmann",
    dob: "1994-07-26T00:00:00.000Z",
    residentialAddress: {
      postalCode: "SE6 9YU",
      countryISO: "GB",
      houseNameNumber: "7",
      street: "Brick Lane",
      townCity: "London"
    },
    roles: [
      primaryContact,
      director
    ]
  }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import json
import requests

requests.post(
  "https://api-json.sandbox.paybase.io/v1/customer/customer/28958679-e8a8-47a8-967c-f979ae8509a2Params: customerId/persons",
  data = json.dumps({
    "profile": {
      "firstName": "Mariana",
      "lastName": "Gutmann",
      "dob": "1994-07-26T00:00:00.000Z",
      "residentialAddress": {
        "postalCode": "SE6 9YU",
        "countryISO": "GB",
        "houseNameNumber": "7",
        "street": "Brick Lane",
        "townCity": "London"
      },
      "roles": [
        "primaryContact",
        "director"
      ]
    }
  }),
  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
19
20
21
22
23
24
25
26
27
28
29
$client = new \GuzzleHttp\Client();
$client->request(
  "post",
  "https://api-json.sandbox.paybase.io/v1/customer/customer/28958679-e8a8-47a8-967c-f979ae8509a2Params: customerId/persons",
  [
    "body" => "{
      \"profile\": {
        \"firstName\": \"Mariana\",
        \"lastName\": \"Gutmann\",
        \"dob\": \"1994-07-26T00:00:00.000Z\",
        \"residentialAddress\": {
          \"postalCode\": \"SE6 9YU\",
          \"countryISO\": \"GB\",
          \"houseNameNumber\": \"7\",
          \"street\": \"Brick Lane\",
          \"townCity\": \"London\"
        },
        \"roles\": [
          \"primaryContact\",
          \"director\"
        ]
      }
    }",
    "headers" => [
      "Content-Type" => "application/json",
      "X-Token" => "<X-Token goes here>",
    ]
  ]
);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl -X POST \
"https://api-json.sandbox.paybase.io/v1/customer/customer/28958679-e8a8-47a8-967c-f979ae8509a2Params: customerId/persons"  -H "Content-Type: application/json" \
  -H "X-Token: <X-Token goes here>" \
  -d '{
    "profile": {
      "firstName": "Mariana",
      "lastName": "Gutmann",
      "dob": "1994-07-26T00:00:00.000Z",
      "residentialAddress": {
        "postalCode": "SE6 9YU",
        "countryISO": "GB",
        "houseNameNumber": "7",
        "street": "Brick Lane",
        "townCity": "London"
      },
      "roles": [
        "primaryContact",
        "director"
      ]
    }
  }'

Request

FieldDescription
customerIdURI Param
string

The unique identifier of the customer with which you want to associate the business person.

Format

customer/_uuid_

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

profile.firstNamerequired
string

The first name of the business person.

profile.lastNamerequired
string

The last name of the business person.

profile.dobrequired
date

The date of the birth of the business person, in UTC.

Input Date Formats

profile.rolesrequired
array<string>

The role that the person occupies in the business.

enum

primaryContact, director, ubo

Each Incorporated Business customer must have at least one primaryContact and director. The same person can have multiple roles.

profile.residentialAddress.flatNumberoptional
string

Flat number.

profile.residentialAddress.houseNameNumberoptional
string

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

profile.residentialAddress.streetoptional
string

Street name.

profile.residentialAddress.townCityoptional
string

Town or city.

profile.residentialAddress.regionoptional
string

Region/County/State/Province.

profile.residentialAddress.postalCodeoptional
string

Postal Code or ZIP.

profile.residentialAddress.countryISOrequired
string

Country code

Format

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

e.g. GB

Response

FieldDescription
id
string

The unique identifier of the business person object.

Format

business_person/_uuid_

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

customerId
string

The unique identifier of the customer with which you want to associate the business person.

Format

customer/_uuid_

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

profile.firstName
string

The first name of the business person.

profile.lastName
string

The last name of the business person.

profile.dob
date

The date of the birth of the business person, in UTC.

Input Date Formats

profile.roles
array<string>

The role that the person occupies in the business.

enum

primaryContact, director, ubo

Each Incorporated Business customer must have at least one primaryContact and director. The same person can have multiple roles.

profile.residentialAddress.flatNumber
string

Flat number.

profile.residentialAddress.houseNameNumber
string

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

profile.residentialAddress.street
string

Street name.

profile.residentialAddress.townCity
string

Town or city.

profile.residentialAddress.region
string

Region/County/State/Province.

profile.residentialAddress.postalCode
string

Postal Code or ZIP.

profile.residentialAddress.countryISO
string

Country code

Format

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

e.g. GB