requestRegistrationOtp

Public: no authentication required.

Step 1 of registering an organization by email: sends a verification code to the address. Rate-limited per IP address. No sign-in needed.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RequestRegistrationOtp($input: RequestRegistrationOtpInput!) {
  requestRegistrationOtp(input: $input) {
    message
    requestId
    success
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RequestRegistrationOtp($input: RequestRegistrationOtpInput!) {\n  requestRegistrationOtp(input: $input) {\n    message\n    requestId\n    success\n  }\n}",
  "variables": {
    "input": {
      "email": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "email": "string"
  }
}

Response:

{
  "data": {
    "requestRegistrationOtp": {
      "message": "string",
      "requestId": "string",
      "success": true
    }
  }
}

requestRegistrationOtp(
  input: RequestRegistrationOtpInput!
): RequestRegistrationOtpResponse!

Arguments

requestRegistrationOtp.input ● RequestRegistrationOtpInput! non-null input

The email address to send the code to.

Type

RequestRegistrationOtpResponse object

The result of step 1 of signing up. The code is only ever sent by email.