verifyRegistrationOtp

Public: no authentication required.

Step 2 of registering an organization by email: checks the emailed code and returns a short-lived verification token for registerWithOtp. 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 VerifyRegistrationOtp($input: VerifyRegistrationOtpInput!) {
  verifyRegistrationOtp(input: $input) {
    expiresIn
    verificationToken
    verified
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation VerifyRegistrationOtp($input: VerifyRegistrationOtpInput!) {\n  verifyRegistrationOtp(input: $input) {\n    expiresIn\n    verificationToken\n    verified\n  }\n}",
  "variables": {
    "input": {
      "email": "string",
      "otp": "string",
      "requestId": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "email": "string",
    "otp": "string",
    "requestId": "string"
  }
}

Response:

{
  "data": {
    "verifyRegistrationOtp": {
      "expiresIn": 0,
      "verificationToken": "string",
      "verified": true
    }
  }
}

verifyRegistrationOtp(
  input: VerifyRegistrationOtpInput!
): VerifyRegistrationOtpResponse!

Arguments

verifyRegistrationOtp.input ● VerifyRegistrationOtpInput! non-null input

The request ID, the email address and the code.

Type

VerifyRegistrationOtpResponse object

The result of step 2 of signing up.