Channel · directory
14 routes. Paths are relative to https://api.intersink.com/v1.
- GET/channel/{channelId}/accountsAccounts that signed up on this channel
- GET/channel/{channelId}/businessesBusinesses created on this channel (?status=all|draft|submitted|…)
- GET/channel/{channelId}/businesses/{businessId}One business created on this channel
- POST/channel/{channelId}/businesses/{businessId}/decisionApprove or reject a business created on this channel
- GET/channel/{channelId}/businesses/{businessId}/verificationVerification checklist of a business created on this channel, with call notes
- GET/channel/{channelId}/businesses/{businessId}/verification/agreementThe agreement text and signature of a business created on this channel
- POST/channel/{channelId}/businesses/{businessId}/verification/callBook the verification call (time, meeting link); the business is emailed
- POST/channel/{channelId}/businesses/{businessId}/verification/call/resultRecord the call: pass, fail or no_show, with what was checked
- POST/channel/{channelId}/businesses/{businessId}/verification/inviteOpen (or close) verification for a business while it is invite-only
- GET/channel/{channelId}/change-requestsChanges to business details waiting for this channel (?status=pending)
- POST/channel/{channelId}/change-requests/{requestId}/decisionApprove (applies the new value) or reject a change request
- POST/channel/{channelId}/documents/{documentId}/reviewVerify or reject a document of a business created on this channel
- GET/channel/{channelId}/signup-policyWho may create an account on this channel
- PATCH/channel/{channelId}/signup-policyOpen to anyone, restricted to listed e-mails and @domains, or closed to new accounts
Accounts that signed up on this channel
GET/channel/{channelId}/accounts
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| status | string, query | recheck: verified businesses checked again after a change to their legal details (draft = not verified yet) One of: "all", "draft", "submitted", "in_review", "approved", "rejected", "archived", "recheck". |
| q | string, query | Search name or e-mail At most 100 characters. |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
Response
200. The payload in data is not described in the spec yet.
Businesses created on this channel (?status=all|draft|submitted|…)
GET/channel/{channelId}/businesses
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| status | string, query | recheck: verified businesses checked again after a change to their legal details (draft = not verified yet) One of: "all", "draft", "submitted", "in_review", "approved", "rejected", "archived", "recheck". |
| q | string, query | Search name or e-mail At most 100 characters. |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
Response
200. The payload in data is not described in the spec yet.
One business created on this channel
GET/channel/{channelId}/businesses/{businessId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Approve or reject a business created on this channel
POST/channel/{channelId}/businesses/{businessId}/decision
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| decisionrequired | string | One of: "approved", "rejected". |
| reason | string | Required when rejecting At most 1000 characters. |
Response
200. The payload in data is not described in the spec yet.
Verification checklist of a business created on this channel, with call notes
GET/channel/{channelId}/businesses/{businessId}/verification
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
The agreement text and signature of a business created on this channel
GET/channel/{channelId}/businesses/{businessId}/verification/agreement
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Book the verification call (time, meeting link); the business is emailed
POST/channel/{channelId}/businesses/{businessId}/verification/call
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Record the call: pass, fail or no_show, with what was checked
POST/channel/{channelId}/businesses/{businessId}/verification/call/result
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Open (or close) verification for a business while it is invite-only
POST/channel/{channelId}/businesses/{businessId}/verification/invite
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Changes to business details waiting for this channel (?status=pending)
GET/channel/{channelId}/change-requests
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| status | string, query | One of: "pending", "approved", "rejected", "cancelled". |
| business_id | string, query | Only this business's requests (the channel's queue) |
Response
200. The payload in data is not described in the spec yet.
Approve (applies the new value) or reject a change request
POST/channel/{channelId}/change-requests/{requestId}/decision
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| requestIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| decisionrequired | string | One of: "approved", "rejected". |
| reason | string | Required when rejecting At most 1000 characters. |
Response
200. The payload in data is not described in the spec yet.
Verify or reject a document of a business created on this channel
POST/channel/{channelId}/documents/{documentId}/review
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| documentIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| statusrequired | string | One of: "verified", "rejected". |
| reason | string | Required when rejecting At most 1000 characters. |
Response
200. The payload in data is not described in the spec yet.
Who may create an account on this channel
GET/channel/{channelId}/signup-policy
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is of type object.
Open to anyone, restricted to listed e-mails and @domains, or closed to new accounts
PATCH/channel/{channelId}/signup-policy
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| moderequired | string | One of: "open", "restricted", "closed". |
| allowed | string[] | E-mail addresses and @domains allowed when restricted |
Response
200. The payload in data is of type object.