Provision a user

post

https://example.com/v1/users

About this API

To get the ins and outs of this API, please refer to our documentation page here

Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.

How to use this page?

Pick a preferred language on the right.
Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
Enter the required parameters below or try something yourself!
Click the Try It! button!

📘
You can also click one of the HTTP response codes at the bottom to see an example of that specific response!

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

201User created

400Malformed JSON body, or a well-formed body containing a field whose JSON type cannot be decoded into the expected type, e.g. a number where a string is expected (title invalid_json); or field validation failure (title validation_failed).

401Missing CI-Subject-URN or CI-Request-Id, absent CI-Role header, or a subject URN not provisioned as a KYC user (title unauthenticated, source.header names the offending header).

403The caller's roles do not satisfy this operation's role gate (title forbidden), or the caller is a tenant user whose tenant is not provisioned in KYC.NEXT (title tenant_not_provisioned, on any operation).

404No tenant is provisioned for tenantId (title not_found, detail "tenant not provisioned").

409The resource already exists (title conflict).

500Unexpected server error (title internal_error).