Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/keys

Body

application/json

The payload required in order to create a customer.

companyName
string
required

The legal name of the customer's company

Example:

"Ollivander's Wand Shop"

companyCountry
string
required

The alpha-2 ISO 3166 country code of the entity's country.

Pattern: ^[A-Za-z]{2}$
Example:

"GB"

externalCustomerId
string
required

The id used to identify the customer within your platform

Example:

"630231b3ae0d7e9e5097ad35"

contactEmail
string

The email for the company's primary contact

Example:

"customer@company.com"

contactFullName
string

The name of the company's primary contact

Example:

"Garrick Ollivander"

contactPhoneNumber
string

The phone number of the company's primary contact

Example:

"+12125551234"

companyAddress
string

The address of the company

Example:

"12 Diagon Alley"

companyCity
string

The city of the company

Example:

"London"

companyState
string

The state the company is in (US based)

Example:

"London"

companyTaxId
string

The tax identification or registration number of the company

Example:

"123-45-6789"

extraFields
object

Additional fields that provide further details about the customer. These fields should be specified as a valid JSON object.

Example:

Response

Customer Updated

A response containing the ID of the created object.

id
string<uuid>
required

The id of the created object.

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
Example:

"1b0ada1e-fa1b-4cfe-a553-01b340c5650e"