Skip to main content
API docs by Redocly

Customer API (1.0.0)

Download OpenAPI specification:Download

Administrator

Admin users API

Business

Lookup assurance information Deprecated

Lookup assurance information for RT or SQC

Authorizations:
jwt
query Parameters
assuranceBody
string
Enum: "RT" "SQC"

RT or SQC

assuranceIdentifier
string

Membership Number or Holding Number

country
required
string = 3 characters
Default: "GBR"

ISO3 country code

postcode
string

Postcode of location

holdingNumber
string

Holding number for scheme

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Get Business

Retrieve business for a business unit

path Parameters
id
required
string

Business Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "businessUnitId": "string",
  • "organisationId": "string",
  • "primary": true,
  • "location": {
    },
  • "collectionLocation": {
    },
  • "businessName": "string",
  • "name": "string",
  • "phone": {
    },
  • "email": "string",
  • "tags": [
    ],
  • "holdingNumber": "string",
  • "assurance": {
    }
}

Get Businesses by business unit IDs

Retrieve business for a business unit

query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Business Units

Create Business Unit

Create a new business unit within an organisation

Authorizations:
jwt
Request Body schema: application/json
organisationId
required
string

Organisation id to which the business units belong

name
required
string

The name of the business unit

type
string
Deprecated

The type of business unit being created

required
object

Responses

Request samples

Content type
application/json
{
  • "organisationId": "string",
  • "name": "string",
  • "type": "string",
  • "business": {
    }
}

Response samples

Content type
application/json
{
  • "ordinal": 0,
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "tags": [
    ],
  • "business": {
    }
}

Get Business Units Summary

Retrieve business units summary for an organisation all of them without filtering by users business units

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "organisationId": "string",
  • "organisationName": "string",
  • "tagGroups": [
    ],
  • "businessUnits": [
    ]
}

Get BusinessUnit

Retrieve business units for an organisation filtered by user

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organisationId": "string",
  • "organisationName": "string",
  • "organisationRegionISO": "string",
  • "tagGroups": [
    ],
  • "businessUnits": [
    ]
}

Update Business Unit

Updates an Organisations business unit properties

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
name
string or null

The name of the business unit

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "business": {
    }
}

Response samples

Content type
application/json
{
  • "ordinal": 0,
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "tags": [
    ],
  • "business": {
    }
}

Delete Business Unit

Delete Business Unit

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Import a batch of business units

CSV Import endpoint to create a set of business units

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

Cognito

Manage user syncing from Cognito to Database and vice versa.

Create an admin user in Cognito

Create an admin user in Cognito

Authorizations:
jwt
Request Body schema: application/json
email
required
string
password
required
string <cognito-password>

Standard cognito password

givenName
required
string
familyName
required
string
readonly
required
boolean
Default: "false"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "readonly": "false"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Create users in Cognito

Creates users in Cognito from the user account in RavenDB. All RavenDB users will be recreated

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Reset customers email & set password if supplied

Reset customers email & set password if supplied

Authorizations:
jwt
Request Body schema: application/json
currentEmail
required
string
newEmail
required
string
password
string or null <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "currentEmail": "string",
  • "newEmail": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Swap a user from one pool to another on login

Swap a user from one pool to another on login

Request Body schema: application/json
username
required
string
password
string <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "status": "not-found",
  • "authenticated": true,
  • "id": "string"
}

Sync all users to Cognito and update Raven if roles have changed

Sync all users to Cognito and update Raven if roles have changed

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

removeUserAttributes

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

cleanCognitoAccounts

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Create User in Cognito

Create a user in Cognito from a user account in RavenDB

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Sync to Cognito

Sync user record from a RavenDB user to Cognito

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Sync from Cognito

Sync information from Cognito to RavenDB for a single user

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Organisations

This API manages the organisation information of customers of Platform

Create organisation

Create a new customers organisation

Authorizations:
jwt
Request Body schema: application/json
required
object or null
object
name
required
string or null

Name of the business

countryISO
required
string = 2 characters
Default: "GB"
Enum: "GB" "US" "ZA" "FR"

Country where the business is based, two letter code

required
object or null
Array of objects or null
organisers
Array of strings
salesforceId
string or null

ID of the account in Salesforce

required
Array of objects
signupPurpose
Array of integers

Responses

Request samples

Content type
application/json
{
  • "location": {
    },
  • "company": {
    },
  • "name": "string",
  • "countryISO": "GB",
  • "ownerContact": {
    },
  • "contacts": [
    ],
  • "organisers": [
    ],
  • "salesforceId": "string",
  • "modules": [
    ],
  • "signupPurpose": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Get Organisations

Get Organisations

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

tags
string

Filter by tags

status
string

Filter by status

count
boolean

If true just return a count

query
string

Free text search field for querying

modules
string

Modules

Responses

Response samples

Content type
application/json
{
  • "docs": [
    ],
  • "custom": { },
  • "totalDocs": 0,
  • "limit": 0,
  • "offset": 0,
  • "clearUrl": "string",
  • "activeFilters": [
    ],
  • "facets": [
    ],
  • "aggregations": [
    ]
}

Create organisation that is not vetted

Create a new pending organisation waiting for approval

Request Body schema: application/json
givenName
required
string
familyName
required
string
email
required
string
phone
required
string or null <phone-number>

Phone number

businessName
required
string
referralCode
string
holdingOrMembershipNumber
string or null
modules
required
Array of strings
signupPurpose
Array of integers
assuranceBody
string or null
Enum: "RT" "SQC" null

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "email": "string",
  • "phone": "string",
  • "businessName": "string",
  • "referralCode": "string",
  • "holdingOrMembershipNumber": "string",
  • "modules": [
    ],
  • "signupPurpose": [
    ],
  • "assuranceBody": "RT"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Get organisations by id

Get organisations records by id

Authorizations:
jwt
query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organisation of the logged in user

Get organisation of the logged in user

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "businessId": "string",
  • "businessUnitId": "string",
  • "createdAtUTC": "string",
  • "name": "string",
  • "location": {
    },
  • "countryISO": "GB",
  • "status": "active",
  • "companyId": "string",
  • "companyHoldingNumber": "string",
  • "bio": "string",
  • "logo": {
    },
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "assurance": {
    },
  • "assuranceId": "string",
  • "assuranceScheme": "RT",
  • "advancePay": {
    },
  • "salesforceId": "string",
  • "salesforceUpdates": [
    ]
}

Get carrier organisations

Get carrier organisations

Authorizations:
jwt

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Organisation

Get Organisation

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Update Organisation

Updates an Organisations properties

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
object or null
object or null
name
string or null

Name of the business

countryISO
string = 2 characters
Default: "GB"
Enum: "GB" "US" "ZA" "FR"

Country where the business is based, two letter code

object or null
Array of objects or null
organisers
Array of strings
salesforceId
string or null
Array of objects
signupPurpose
Array of integers
companyNumber
string or null
Deprecated

Legal number associated with an incorporated business

companySalesTaxId
string or null
Deprecated
Array of objects or null
object or null
status
string or null
statusMessage
string or null
salesforceUpdates
Array of strings or null
vetted
boolean
isMerchant
boolean
rejected
boolean

Responses

Request samples

Content type
application/json
{
  • "location": {
    },
  • "company": {
    },
  • "name": "string",
  • "countryISO": "GB",
  • "ownerContact": {
    },
  • "contacts": [
    ],
  • "organisers": [
    ],
  • "salesforceId": "string",
  • "modules": [
    ],
  • "signupPurpose": [
    ],
  • "companyNumber": "string",
  • "companySalesTaxId": "string",
  • "settlementContacts": [
    ],
  • "logo": {
    },
  • "status": "string",
  • "statusMessage": "string",
  • "salesforceUpdates": [
    ],
  • "vetted": true,
  • "isMerchant": true,
  • "rejected": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Update Organisation Advance Pay Details

Updates an Organisations advance pay details

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
accountName
required
string
sortCode
required
string^\d{2}-\d{2}-\d{2}$
accountNumber
required
string^\d{8}$
status
boolean or null

Responses

Request samples

Content type
application/json
{
  • "accountName": "string",
  • "sortCode": "string",
  • "accountNumber": "string",
  • "status": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Import a batch of organisations

CSV Import endpoint to create a set of organisations

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

Import a batch of preferences

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

Import a batch of preferences for sellers

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

set preferences

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

set seller preferences

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

Import FinMid account status

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

Import FinMid sellers

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

Roles

Get Roles

Returns a list of roles grouped by functional area

Authorizations:
jwt

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Refresh Roles

Refresh roles of users and sync with cognito

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Users

Change Owner

Changes the owner of the organisation

Authorizations:
jwt
Request Body schema: application/json
newOwnerUserId
required
string

The user id to be the new owner

Responses

Request samples

Content type
application/json
{
  • "newOwnerUserId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Get Users

Get Users

Authorizations:
jwt
query Parameters
limit
integer

Limit page size of results

offset
integer

Number of results to skip for the current page

sortBy
string

Sort results by this field

sortDesc
boolean

Sort results descending if true, otherwise ascending

query
string

Free text search field for querying

status
string

Filter by status

count
boolean

If true just return a count

organisationId
string

Organisation Id

organisationIds
string

Permissioned Organisation Id

Responses

Response samples

Content type
application/json
{
  • "docs": [
    ],
  • "totalDocs": 0,
  • "limit": 0,
  • "offset": 0
}

Create user

Create a new customer user. This endpoint can only be used by team owners creating users for their organisation

Authorizations:
jwt
Request Body schema: application/json
givenName
required
string
familyName
required
string
countryISO
string = 2 characters
Default: "GB"
Enum: "GB" "US" "ZA" "FR"

Country where the business is based, two letter code

organisationId
string
email
required
string
phone
required
string or null <phone-number>

Phone number

pushToken
string or null
roles
Array of strings or null

The role this user has

businessUnits
Array of strings or null

The user business units, list of ids

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "GB",
  • "organisationId": "string",
  • "email": "string",
  • "phone": "string",
  • "pushToken": "string",
  • "roles": [
    ],
  • "businessUnits": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "type": "internal",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "GB",
  • "email": "string",
  • "pushToken": "string",
  • "external": false,
  • "impersonating": false,
  • "settings": {
    },
  • "tokens": {
    },
  • "groups": [
    ],
  • "roles": [
    ],
  • "userTypes": [
    ],
  • "profiles": [
    ],
  • "preferences": [
    ],
  • "sellerPreferences": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "organisationId": "string",
  • "organisationName": "string",
  • "authPlatformId": "string",
  • "status": "active",
  • "businessUnits": [
    ],
  • "notificationsEnabled": true
}

Delete User

Delete User

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Get User

Get User

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "type": "internal",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "GB",
  • "email": "string",
  • "pushToken": "string",
  • "external": false,
  • "impersonating": false,
  • "settings": {
    },
  • "tokens": {
    },
  • "groups": [
    ],
  • "roles": [
    ],
  • "userTypes": [
    ],
  • "profiles": [
    ],
  • "preferences": [
    ],
  • "sellerPreferences": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "organisationId": "string",
  • "organisationName": "string",
  • "authPlatformId": "string",
  • "status": "active",
  • "businessUnits": [
    ],
  • "notificationsEnabled": true
}

Patch User

Patch User

Authorizations:
jwt
path Parameters
id
required
string

User Id

Request Body schema: application/json
givenName
string
familyName
string
countryISO
string = 2 characters
Default: "GB"
Enum: "GB" "US" "ZA" "FR"

Country where the business is based, two letter code

organisationId
string
email
string
phone
string or null <phone-number>

Phone number

pushToken
string or null
roles
Array of strings or null

The role this user has

businessUnits
Array of strings or null

The user business units, list of ids

phoneLandline
string or null <phone-number>

Phone number

object or null
termsAgreed
boolean or null
marketingEmails
boolean or null
Deprecated
object
whatsAppNotifications
boolean or null
smsNotifications
boolean or null
preferences
Array of strings or null
onboardingProgress
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "GB",
  • "organisationId": "string",
  • "email": "string",
  • "phone": "string",
  • "pushToken": "string",
  • "roles": [
    ],
  • "businessUnits": [
    ],
  • "phoneLandline": "string",
  • "avatar": {
    },
  • "termsAgreed": true,
  • "marketingEmails": true,
  • "marketingPreferences": {
    },
  • "whatsAppNotifications": true,
  • "smsNotifications": true,
  • "preferences": [
    ],
  • "onboardingProgress": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "type": "internal",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "GB",
  • "email": "string",
  • "pushToken": "string",
  • "external": false,
  • "impersonating": false,
  • "settings": {
    },
  • "tokens": {
    },
  • "groups": [
    ],
  • "roles": [
    ],
  • "userTypes": [
    ],
  • "profiles": [
    ],
  • "preferences": [
    ],
  • "sellerPreferences": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "organisationId": "string",
  • "organisationName": "string",
  • "authPlatformId": "string",
  • "status": "active",
  • "businessUnits": [
    ],
  • "notificationsEnabled": true
}

Resend User password

Resend users temporary password (resend invite)

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Verify Attribute Update

User update email and phone attribute confirmation, takes a username and a confirmation code and sets the users account to confirmed, allowing that user to login

Authorizations:
jwt
Request Body schema: application/json
code
required
string

Six digit code sent to user to confirm their update

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Find users by preferences

Lookup user summaries for all users who match the incoming preferences excluding users in the organisationId supplied.

Authorizations:
jwt
query Parameters
preferences
string

User preferences array. comma separated

organisationId
string

Filter by organisation Id

userType
string

User type buyer or seller

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Set users buyer preferences

Overwrites any existing buyer preferences with the incoming array. These preferences are used to notify trade users about open trade listings.

Authorizations:
jwt
Request Body schema: application/json
required
Array of objects
notificationsEnabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "preferences": [
    ],
  • "notificationsEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "type": "internal",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "GB",
  • "email": "string",
  • "pushToken": "string",
  • "external": false,
  • "impersonating": false,
  • "settings": {
    },
  • "tokens": {
    },
  • "groups": [
    ],
  • "roles": [
    ],
  • "userTypes": [
    ],
  • "profiles": [
    ],
  • "preferences": [
    ],
  • "sellerPreferences": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "organisationId": "string",
  • "organisationName": "string",
  • "authPlatformId": "string",
  • "status": "active",
  • "businessUnits": [
    ],
  • "notificationsEnabled": true
}

Lookup User By Telephone

Lookup or create a user by a telephone number

Authorizations:
jwt
Request Body schema: application/json
phone
string or null <phone-number>

Phone number

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "type": "internal",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "GB",
  • "email": "string",
  • "pushToken": "string",
  • "external": false,
  • "impersonating": false,
  • "settings": {
    },
  • "tokens": {
    },
  • "groups": [
    ],
  • "roles": [
    ],
  • "userTypes": [
    ],
  • "profiles": [
    ],
  • "preferences": [
    ],
  • "sellerPreferences": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "organisationId": "string",
  • "organisationName": "string",
  • "authPlatformId": "string",
  • "status": "active",
  • "businessUnits": [
    ],
  • "notificationsEnabled": true
}

Mailchimp callback

Mailchimp callback endpoint for webhooks

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Mailchimp callback exists check

Mailchimp callback exists check endpoint for webhook. Mailchimp uses this endpoint to verify that the endpoint exists.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Mailchimp callback exists check

Mailchimp callback exists check endpoint for webhook. Mailchimp uses this endpoint to verify that the endpoint exists.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Customers

Delete an organisation

Delete an organisation and all related data

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Impersonate an organisation

Returns an encrypted impersonation token valid for 1 hour for the specified organisation

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

query Parameters
userId
string

User Id

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Activate an organisation

Set an organisation to active and resent account welcome email to owner

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Adds a module to an organisation

Add a module to the organisation and configure security for the owner

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
id
required
string
name
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Remove a module from an organisation

Removed a module from the organisation and configure security for the owner

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "location": {
    },
  • "company": {
    },
  • "companyNumber": "string",
  • "countryISO": "GB",
  • "name": "string",
  • "ownerContact": {
    },
  • "settlementContacts": [
    ],
  • "status": "active",
  • "statusMessage": "string",
  • "businessUnits": [
    ],
  • "modules": [
    ],
  • "vetted": true,
  • "rejected": true,
  • "isMerchant": true,
  • "createdAtUTC": "string",
  • "advancePay": {
    },
  • "salesforceId": "string"
}

Send a request to CS to add a module

Sends a message to a slack channel to request a new module for an organisation

Authorizations:
jwt
path Parameters
id
required
string

Organisation Id

Request Body schema: application/json
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Link a user from another organisation to authenticated users organisation via a profile

Authorizations:
jwt
Request Body schema: application/json
userId
required
string
roles
required
Array of strings or null

The role this user has

businessUnits
Array of strings or null

The user business units, list of ids

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "roles": [
    ],
  • "businessUnits": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "type": "internal",
  • "familyName": "string",
  • "name": "string",
  • "countryISO": "GB",
  • "email": "string",
  • "pushToken": "string",
  • "external": false,
  • "impersonating": false,
  • "settings": {
    },
  • "tokens": {
    },
  • "groups": [
    ],
  • "roles": [
    ],
  • "userTypes": [
    ],
  • "profiles": [
    ],
  • "preferences": [
    ],
  • "sellerPreferences": [
    ],
  • "phone": {
    },
  • "phoneLandline": {
    },
  • "avatar": {
    },
  • "organisationId": "string",
  • "organisationName": "string",
  • "authPlatformId": "string",
  • "status": "active",
  • "businessUnits": [
    ],
  • "notificationsEnabled": true
}

Unlink a user from another organisation

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Retrieve authenticated users profile

Retrieves the logged in customers profile (user & org)

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    },
  • "access": {
    },
  • "tokens": {
    }
}

Retrieve users by ids

Retrieve users by ids

Authorizations:
jwt
query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Retrieve users summary by ids

Retrieve users summary by ids

Authorizations:
jwt
query Parameters
ids
required
string

Comma separated list of ids

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Retrieve users by roles

Retrieve users by roles

Authorizations:
jwt
query Parameters
include
string

include these array items

exclude
string

exclude these array items

organisationId
string

Organisation Id

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Retrieve basic info for a user

Retrieve basic info for a user

Authorizations:
jwt
path Parameters
id
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "countryISO": "GB",
  • "organisationName": "string",
  • "organisationId": "string",
  • "email": "string",
  • "phone": {
    },
  • "pushToken": "string",
  • "organisation": {
    },
  • "preferences": [
    ],
  • "settings": {
    },
  • "authPlatformId": "string",
  • "userTypes": [
    ]
}

Authenticate a user based on an ApiToken

Authenticate a user based on an ApiToken and return their profile with the auth tokens

Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    },
  • "access": {
    },
  • "tokens": {
    }
}

Generate an ApiToken for a user

Generate an ApiToken for a user

Authorizations:
jwt
Request Body schema: application/json
userId
required
string
hours
required
number
roles
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "hours": 0,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Admin

Generate an ApiToken for a user

Generate an ApiToken for a user

Authorizations:
jwt
Request Body schema: application/json
userId
required
string
hours
required
number
roles
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "hours": 0,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Admin reset password

Admin initiated password reset request on behalf of a user

Authorizations:
jwt
Request Body schema: application/json
username
string

email or username

phone
string

phone number

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Admin set password

Admin initiated set password request on behalf of a user

Authorizations:
jwt
Request Body schema: application/json
username
required
string
password
required
string <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Global

Login

User initiated login

Request Body schema: application/json
username
required
string

Phone, email address or username

password
required
string
newPassword
string <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "tokens": {
    },
  • "challenge": {
    }
}

Change Password

User initiated change password request

Authorizations:
jwt
Request Body schema: application/json
email
string or null
oldPassword
required
string
newPassword
required
string <cognito-password>

Standard cognito password

confirmNewPassword
required
string <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "oldPassword": "string",
  • "newPassword": "string",
  • "confirmNewPassword": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Forgotten Password

User initiated forgotten password request

Request Body schema: application/json
username
string

email or username

phone
string

phone number

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "attributeName": "string",
  • "deliveryMedium": "string",
  • "destination": "string"
}

Reset password

User initiated forgotten password confirmation request

Request Body schema: application/json
username
required
string
password
string <cognito-password>

Standard cognito password

passwordConfirm
string <cognito-password>

Standard cognito password

confirmationCode
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "passwordConfirm": "string",
  • "confirmationCode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Logout user

Invalidates the users tokens

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Refresh tokens

Refresh the Access and ID tokens

Responses

Response samples

Content type
application/json
{
  • "tokens": {
    },
  • "challenge": {
    }
}

Resend the users password

Resend users temporary password (resend invite)

path Parameters
id
required
string

User AuthPlatform Id

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

User

Confirm Signup

User initiated signup confirmation, takes a username and a confirmation code and sets the users account to confirmed, allowing that user to login

Request Body schema: application/json
username
required
string

users authPlatformId

confirmationCode
required
string

Six digit code sent to user to confirm their account

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "confirmationCode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Send Magic Login Link

Takes a user email or phone and begins authentication through cognito, sending a login link to the user via email

query Parameters
email
string

Contacts email address

phone
string

User phone

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Verify Magic Link

User was sent whatsapp link with code. Code from that link will be posted to this endpoint to verify their login.

Request Body schema: application/json
id
required
string

Auth Lookup Id

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Authenticate a user based on an ApiToken

Authenticate a user based on an ApiToken and return their profile with the auth tokens

Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "organisation": {
    },
  • "user": {
    },
  • "access": {
    },
  • "tokens": {
    }
}

Change Marketplace password

User initiated change marketplace password request

Request Body schema: application/json
email
string or null
oldPassword
required
string
newPassword
required
string <cognito-password>

Standard cognito password

confirmNewPassword
required
string <cognito-password>

Standard cognito password

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "oldPassword": "string",
  • "newPassword": "string",
  • "confirmNewPassword": "string"
}

Response samples

Content type
application/json
{
  • "tokens": {
    },
  • "challenge": {
    }
}

Operations

Do something to an entity

Authorizations:
jwt
Request Body schema: multipart/form-data
organisationId
string or null
organisationName
string or null
file
required
Array of strings <binary>

Responses

Response samples

Content type
application/json
{
  • "success": 0,
  • "validation": 0,
  • "errors": 0,
  • "results": [
    ]
}

System

Misc

Misc

Authorizations:
jwt
query Parameters
type
string

Filter by type

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Configuration

Retrieve customer configuration

Retrieve customer configuration

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "signupPurposes": [
    ]
}

Assurance

Find assurance from table Deprecated

Finds an assurance via an identifier

query Parameters
assuranceIdentifier
required
string

Membership Number or Holding Number

assuranceBody
required
string
Enum: "RT" "SQC"

RT or SQC

organisationId
string

Organisation Id

businessId
string

Business Id

Responses

Response samples

Content type
application/json
{
  • "membershipId": "string",
  • "name": "string",
  • "holdingNumber": "string",
  • "county": "string",
  • "postcode": "string",
  • "address": "string",
  • "contactName": "string",
  • "scheme": "RT",
  • "assured": true,
  • "certificationStartDate": "string",
  • "certificationEndDate": "string",
  • "certificateUrl": "string",
  • "crops": [
    ]
}

Lookup customers assurance from insights

Finds an assurance via an identifier or key

query Parameters
assuranceIdentifier
string

Membership Number or Holding Number

assuranceBody
required
string
Enum: "RT" "SQC"

RT or SQC

assuranceKey
string

Unique RT account key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers System

Ping api

Ping customers api

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Execute event

Execute event in customers module

Authorizations:
jwt
path Parameters
action
required
string

Action to perform

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update system settings

Change the system settings document in the customers module

Authorizations:
jwt
Request Body schema: application/json
required
object
level
required
string
filter
required
string or null

Responses

Request samples

Content type
application/json
{
  • "logging": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Trigger

Authorizations:
jwt

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}