Service Provider
Create CRB
Create a new CRB and associate with service provider.
There are two supported onboarding workflows:
-
Provide POS Credentials Up Front (pos_info)
- Use when the CRB has already provided their POS credentials.
- Include the pos_info object in your request.
- Inviting users is optional.
-
Invite the CRB for In-App Onboarding
- Use when you don't have the CRB's POS credentials yet.
- Do NOT include pos_info.
- MUST include at least one user in the 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.
Validation Rules
If pos_info is provided:
- Org business_type must match pos_type (e.g. wholesale org must use a wholesale POS like "Dutchie Wholesale").
- Credentials must be valid; a test POS call is made.
- If the POS requires a location_id, it must be valid.
- If missing or invalid, a validation error is returned with valid options.
- The org must not already be connected to your account.
If pos_info is NOT provided:
- At least one user must be included in the users array.
Testing Scenarios (Sandbox Only)
- Provide pos_info with a wholesale POS, but business_type = "retail" → Expect validation error.
- Provide pos_info with:
- pos_type = "Greenbits"
- username = "testing"
- password = "invalid_testing" → Simulates invalid credentials
- password = "testing" → Simulates valid credentials
- Leave location_id empty → Simulates missing required location, returns available options.
- Set location_id = "invalidLocation" → Simulates invalid location, returns available options.
- Set location_id = "testing" → Simulates successful connection (no actual POS connection made).
post/service-providers/{sp_id}/crbs
Request
- Base URLhttps://sandbox-api.greencheckverified.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
sp_idstring required
Service Provider Id
Request body
Response
Ok
Changes
No recorded changes to this operation across all 1 revision of this API.