Onboard
curl --request POST \
--url https://api.sortx.co.uk/companies/onboard \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"legalName": "<string>",
"addressLine1": "<string>",
"mainContact": {
"firstName": "<string>",
"email": "<string>",
"phone": "<string>",
"lastName": "<string>"
},
"sendInvite": true,
"insuranceExpiresOn": "<string>",
"tradingName": "<string>",
"registrationNumber": "<string>",
"addressTown": "<string>",
"addressPostcode": "<string>",
"contractor": {
"trades": [
"<string>"
],
"councils": [
"<string>"
],
"emergencyCallouts": true
},
"supplier": {
"supplies": [
"<string>"
],
"deliveryArea": "<string>"
},
"vatNumber": "<string>",
"invoiceEmail": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
legalName: '<string>',
addressLine1: '<string>',
mainContact: {
firstName: '<string>',
email: '<string>',
phone: '<string>',
lastName: '<string>'
},
sendInvite: true,
insuranceExpiresOn: '<string>',
tradingName: '<string>',
registrationNumber: '<string>',
addressTown: '<string>',
addressPostcode: '<string>',
contractor: {trades: ['<string>'], councils: ['<string>'], emergencyCallouts: true},
supplier: {supplies: ['<string>'], deliveryArea: '<string>'},
vatNumber: '<string>',
invoiceEmail: '<string>'
})
};
fetch('https://api.sortx.co.uk/companies/onboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/companies/onboard"
payload = {
"requestId": "<string>",
"legalName": "<string>",
"addressLine1": "<string>",
"mainContact": {
"firstName": "<string>",
"email": "<string>",
"phone": "<string>",
"lastName": "<string>"
},
"sendInvite": True,
"insuranceExpiresOn": "<string>",
"tradingName": "<string>",
"registrationNumber": "<string>",
"addressTown": "<string>",
"addressPostcode": "<string>",
"contractor": {
"trades": ["<string>"],
"councils": ["<string>"],
"emergencyCallouts": True
},
"supplier": {
"supplies": ["<string>"],
"deliveryArea": "<string>"
},
"vatNumber": "<string>",
"invoiceEmail": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"company": {
"id": "<string>",
"legacyContactId": "<string>",
"name": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressTown": "<string>",
"addressPostcode": "<string>",
"overseas": true,
"roles": [
"<string>"
],
"registrationNumber": "<string>",
"registrationJurisdiction": "<string>",
"website": "<string>",
"notes": "<string>",
"tradingName": "<string>",
"supplierCategories": [
"<string>"
],
"deliveryArea": "<string>",
"paymentTerms": "<string>",
"vatNumber": "<string>",
"invoiceEmail": "<string>",
"insuranceExpiresOn": "<string>",
"primaryContactId": "<string>",
"revision": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"people": [
{
"contactId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"archivedAt": "<string>",
"kind": "<string>"
}
]
},
"primaryContactId": "<string>",
"contractor": {
"contactId": "<string>",
"name": "<string>",
"kind": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"mobile": "<string>",
"contactArchivedAt": "<string>",
"isContractor": true,
"status": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"councils": [
"<string>"
],
"emergencyCallouts": true,
"availability": "<string>",
"availableFrom": "<string>",
"availabilityNote": "<string>",
"preferenceRank": 123,
"ratesNotes": "<string>",
"notes": "<string>",
"deactivatedAt": "<string>",
"deactivationReason": "<string>",
"deactivatedByName": "<string>",
"revision": 123,
"updatedAt": "<string>",
"credentials": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"approvedAt": "<string>",
"approvedByName": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"prospect": {
"provider": "<string>",
"externalId": "<string>",
"searchTrade": "<string>",
"searchPostcode": "<string>",
"addedByName": "<string>",
"addedAt": "<string>",
"invitedAt": "<string>",
"invitedVia": "<string>",
"invitedByName": "<string>",
"invitationCount": 123,
"activatedAt": "<string>",
"activatedByName": "<string>",
"checkNote": "<string>",
"dismissedAt": "<string>",
"dismissedByName": "<string>",
"dismissReason": "<string>"
}
},
"insuranceCredentialId": "<string>",
"invite": {
"status": "not_requested",
"email": "<string>",
"note": "<string>"
},
"replayed": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}company-onboarding
Onboard
Add a contractor or supplier with its main contact, trades or supplies, insurance and billing terms, and invite it to SortX
POST
/
companies
/
onboard
Onboard
curl --request POST \
--url https://api.sortx.co.uk/companies/onboard \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"legalName": "<string>",
"addressLine1": "<string>",
"mainContact": {
"firstName": "<string>",
"email": "<string>",
"phone": "<string>",
"lastName": "<string>"
},
"sendInvite": true,
"insuranceExpiresOn": "<string>",
"tradingName": "<string>",
"registrationNumber": "<string>",
"addressTown": "<string>",
"addressPostcode": "<string>",
"contractor": {
"trades": [
"<string>"
],
"councils": [
"<string>"
],
"emergencyCallouts": true
},
"supplier": {
"supplies": [
"<string>"
],
"deliveryArea": "<string>"
},
"vatNumber": "<string>",
"invoiceEmail": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
legalName: '<string>',
addressLine1: '<string>',
mainContact: {
firstName: '<string>',
email: '<string>',
phone: '<string>',
lastName: '<string>'
},
sendInvite: true,
insuranceExpiresOn: '<string>',
tradingName: '<string>',
registrationNumber: '<string>',
addressTown: '<string>',
addressPostcode: '<string>',
contractor: {trades: ['<string>'], councils: ['<string>'], emergencyCallouts: true},
supplier: {supplies: ['<string>'], deliveryArea: '<string>'},
vatNumber: '<string>',
invoiceEmail: '<string>'
})
};
fetch('https://api.sortx.co.uk/companies/onboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/companies/onboard"
payload = {
"requestId": "<string>",
"legalName": "<string>",
"addressLine1": "<string>",
"mainContact": {
"firstName": "<string>",
"email": "<string>",
"phone": "<string>",
"lastName": "<string>"
},
"sendInvite": True,
"insuranceExpiresOn": "<string>",
"tradingName": "<string>",
"registrationNumber": "<string>",
"addressTown": "<string>",
"addressPostcode": "<string>",
"contractor": {
"trades": ["<string>"],
"councils": ["<string>"],
"emergencyCallouts": True
},
"supplier": {
"supplies": ["<string>"],
"deliveryArea": "<string>"
},
"vatNumber": "<string>",
"invoiceEmail": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"company": {
"id": "<string>",
"legacyContactId": "<string>",
"name": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressTown": "<string>",
"addressPostcode": "<string>",
"overseas": true,
"roles": [
"<string>"
],
"registrationNumber": "<string>",
"registrationJurisdiction": "<string>",
"website": "<string>",
"notes": "<string>",
"tradingName": "<string>",
"supplierCategories": [
"<string>"
],
"deliveryArea": "<string>",
"paymentTerms": "<string>",
"vatNumber": "<string>",
"invoiceEmail": "<string>",
"insuranceExpiresOn": "<string>",
"primaryContactId": "<string>",
"revision": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"people": [
{
"contactId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"archivedAt": "<string>",
"kind": "<string>"
}
]
},
"primaryContactId": "<string>",
"contractor": {
"contactId": "<string>",
"name": "<string>",
"kind": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"mobile": "<string>",
"contactArchivedAt": "<string>",
"isContractor": true,
"status": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"councils": [
"<string>"
],
"emergencyCallouts": true,
"availability": "<string>",
"availableFrom": "<string>",
"availabilityNote": "<string>",
"preferenceRank": 123,
"ratesNotes": "<string>",
"notes": "<string>",
"deactivatedAt": "<string>",
"deactivationReason": "<string>",
"deactivatedByName": "<string>",
"revision": 123,
"updatedAt": "<string>",
"credentials": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"approvedAt": "<string>",
"approvedByName": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"prospect": {
"provider": "<string>",
"externalId": "<string>",
"searchTrade": "<string>",
"searchPostcode": "<string>",
"addedByName": "<string>",
"addedAt": "<string>",
"invitedAt": "<string>",
"invitedVia": "<string>",
"invitedByName": "<string>",
"invitationCount": 123,
"activatedAt": "<string>",
"activatedByName": "<string>",
"checkNote": "<string>",
"dismissedAt": "<string>",
"dismissedByName": "<string>",
"dismissReason": "<string>"
}
},
"insuranceCredentialId": "<string>",
"invite": {
"status": "not_requested",
"email": "<string>",
"note": "<string>"
},
"replayed": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
Body
application/json