Onboarding Customers

⚠️

Customer creation is currently unavailable for US residents


1. Create a Customer

See API Reference

curl --request POST \
  --url https://api.sandbox.keyrails.com/api/v1/customers \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{AccessToken}}'  \
  --data '{
  "businessType": "Cooperative",
  "email": "string",
  "businessLegalName": "string",
  "businessTradeName": "string",
  "countryOfIncorporation": "string",
  "companyRegistrationNumber": "string",
  "incorporationDate": "YYYY-mm-dd",
  "businessModel": "string",
  "website": "string",
  "registeredAddress": {
    "street1": "string",
    "city": "string",
    "country": "GB"
  },
  "operationalAddress": {
    "street1": "string",
    "city": "string",
    "country": "GB"
  },
  "contactPerson": {
    "firstName": "string",
    "lastName": "string",
    "phoneNumber": "+447912345678",
    "email": "string"
  },
  "businessIndustries": [
    "1231"
  ],
  "isBusinessRegulated": false,
  "accountPurpose": "Payroll",
  "sourceOfFunds": "BusinessLoans",
  "transactionBreakdown": {
    "averageTransactionSize": 100000,
    "maxTransactionSize": 200000,
    "minTransactionSize": 300000,
    "monthlyVolume": 400000,
    "averageSizeToKeyrails": 500000,
    "monthlyVolumeKeyrails": 600000
  },
  "businessDocuments": {
    "certificateOfIncorporation": "data:image/png;base64,xxxxxxxxxxx",
    "articlesOfAssociation": "data:image/png;base64,xxxxxxxxxxx",
    "companyProofOfAddress": "data:image/[type];base64,xxxxxxxxxxx",
    "processingStatements": "data:image/[type];base64,xxxxxxxxxxx",
    "directorsRegister": "data:image/[type];base64,xxxxxxxxxxx",
    "shareholdersRegister": "data:image/[type];base64,xxxxxxxxxxx"
  },
  "associatedPersons": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "email": "string",
      "dateOfBirth": "YYYY-MM-DD",
      "phone": "+447912345678",
      "taxIdentificationNumber": "string",
      "jobTitle": "string",
      "shareHolderPercentage": 25,
      "relationshipEstablishedAt": "YYYY-MM-DD",
      "address": {
        "street1": "string",
        "city": "string",
        "country": "string"
      },
      "identityInformation": [
        {
          "type": "driversLicense"
        }
      ],
      "documents": [
        {
          "documentType": "Passport",
          "file": "data:image/[type];base64,xxxxxxxxxx"
        }
      ]
    }
  ]
}
'

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

What’s Next