Create a new CRB and associate with service provider.
There are two supported onboarding workflows:
Provide POS Credentials Up Front (pos_info
)
pos_info
object in your request.Invite the CRB for In-App Onboarding
pos_info
.users
array to send an invite.Note: You MUST provide either pos_info
OR users
with at least one entry. You may also provide both.
If pos_info
is provided:
business_type
must match pos_type
(e.g. wholesale org must use a wholesale POS like "Dutchie Wholesale").location_id
, it must be valid.If pos_info
is NOT provided:
users
array.pos_info
with a wholesale POS, but business_type = "retail"
→ Expect validation error.pos_info
with:pos_type = "Greenbits"
username = "testing"
password = "invalid_testing"
→ Simulates invalid credentialspassword = "testing"
→ Simulates valid credentialslocation_id
empty → Simulates missing required location, returns available options.location_id = "invalidLocation"
→ Simulates invalid location, returns available options.location_id = "testing"
→ Simulates successful connection (no actual POS connection made).Ok
Unauthorized
Forbidden
Not Found
Conflict
Validation Failed
{- "org": {
- "monthlyCustomers": 0,
- "monthlySales": 0,
- "dba": "string",
- "entityType": "sole",
- "ptEmployees": 0,
- "ftEmployees": 0,
- "established_date": "2019-08-24T14:15:22Z",
- "website": "string",
- "phone_number": "string",
- "ein": "string",
- "mailing_postal_code": "string",
- "mailing_state": "AL",
- "mailing_city": "string",
- "mailing_street_address": "string",
- "country": "Afghanistan",
- "postal_code": "string",
- "city": "string",
- "street_address_2": "string",
- "street_address": "string",
- "primary_contact_email": "string",
- "business_type": "retail",
- "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
- "timezone": "America/New_York",
- "state": "AL",
- "name": "string"
}, - "pos_info": {
- "location_id": "string",
- "pos_credentials": {
- "username": "string",
- "password": "string"
}, - "pos_type": "Alleaves"
}, - "users": [
- {
- "phone": "string",
- "email": "string",
- "lastName": "string",
- "firstName": "string"
}
], - "options": {
- "onboarding_required": true
}
}
{- "mailing_street_address": "415 Main St",
- "mailing_city": "Miami",
- "mailing_state": "IL",
- "mailing_postal_code": "33101",
- "established_date": "2022-02-02T00:00:00.000Z",
- "ftEmployees": 22,
- "ptEmployees": 43,
- "entityType": "partnership",
- "dba": "Green Check Dispensary",
- "monthlySales": "1000",
- "monthlyCustomers": "1000",
- "id": "be2BA1c8-C9BE-76bb-1010-3D7C9908f0AC",
- "name": "Dispensary1",
- "street_address": "9608 Alexandrea Club",
- "street_address_2": null,
- "city": "New Elizabeth",
- "ein": "55-5555555",
- "phone_number": "958-814-8336",
- "postal_code": null,
- "country": "unitedstates",
- "state": "GU",
- "website": null,
- "timezone": "Pacific/Pago_Pago"
}