v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Participant Jurisdictions

Evaluate participant onboarding

Returns a status whether the onboarding operation is allowed or not.

post/jurisdiction/evaluate-onboarding

Query parameters

jurisdiction_codestring required
Example:US-NY

Verify whether the calling platform is permitted to onboard to the given jurisdiction or not

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Returns whether the calling platform is permitted to onboard participants into the given jurisdiction.

allowedboolean

whether participant onboarding is allowed or not for the given jurisdiction

Example response

{
  "allowed": true
}