Skip to content
Testnet only: a reference implementation, not a production service.Tokens and bank transfers here are simulated and have no value.

Signup

1 operations under signup. Examples read $API and $KEY from your shell.

POST /v1/signup

Send an Idempotency-Key header on every POST so a retry never repeats the request.

Request body

application/json, required

object

  • email string required
  • org_name string required

Responses

201 Default Response

object

  • org_id string required
  • user_id string required
  • enrolment_token string optional
  • enrolment_url string optional

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  -X POST \
  "$API/v1/signup" \
  -H "authorization: Bearer $KEY" \
  -H "idempotency-key: $(uuidgen)" \
  -H "content-type: application/json" \
  -d '{"email":"<email>","org_name":"<org_name>"}'
Copied

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key and an Idempotency-Key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.POST("/v1/signup", {
  body: {
    "email": "<email>",
    "org_name": "<org_name>"
  },
});
Copied

Edit on GitHub