verifyCustomerRegistrationOtp

Public: no authentication required.

Check a registration OTP without creating an account and without consuming the code, so the registration form can be opened knowing the mailbox is owned and the same code can still sign the new account in afterwards.

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 VerifyCustomerRegistrationOtp($input: VerifyCustomerOtpInput!) {
  verifyCustomerRegistrationOtp(input: $input)
}

cURL

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

Variables:

{
  "input": {
    "code": "string",
    "email": "string"
  }
}

Response:

{
  "data": {
    "verifyCustomerRegistrationOtp": true
  }
}

verifyCustomerRegistrationOtp(
  input: VerifyCustomerOtpInput!
): Boolean!

Arguments

verifyCustomerRegistrationOtp.input ● VerifyCustomerOtpInput! non-null input

The details of the verify customer otp request.

Type

Boolean scalar

The Boolean scalar type represents true or false.