Skip to main content

verify-signup-request 

dci verify-signup-request <signupRequestId> [body]

Confirms ownership of the admin email by entering the 6-digit code that was emailed when the request was created (or resent). Success records consent and starts provisioning; the request moves to consented and then completed. Five wrong codes lock the current code; request a new one with resendSignupVerification.

  • signupRequestId — Public signup request id (sr_ prefix).

Pass the request body as name: value arguments or pipe JSON on stdin — see Command structure.

Entering the code confirms ownership of the admin email, records consent and starts provisioning. The activationToken is returned once, by the call that performed the verification. Five wrong codes lock the current code (429, verification_locked); request a new one with dci resend-signup-verification. An expired or wrong code returns 400 (verification_code_expired, verification_code_invalid), and a request that is not awaiting verification returns 409. No authentication is needed.

Examples​

# Verify the request with the 6-digit code that was emailed to the admin.
dci verify-signup-request <signup-request-id> code: "123456"
The request moves to `consented` and then `completed`. The response carries the one-time `activationToken` for `dci create-signup-session`.
# Capture the activation token for the next step.
dci verify-signup-request <signup-request-id> code: "123456" --output json | jq -r .activationToken

Request​

Content-Type: application/json

FieldTypeRequiredDescription
codestringyesThe 6-digit code from the verification email.
Raw JSON schema
{
  "type": "object",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "minLength": 6,
      "maxLength": 6,
      "pattern": "^[0-9]{6}$",
      "description": "The 6-digit code from the verification email."
    }
  }
}

Output​

OK - the request is consented; resultToken authorizes subsequent polling. The code is consumed once.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
idstringPublic request id (sr_ prefix); an unguessable capability.
statusstringOne of: "pending_consent", "consented", "provisioning", "completed", "rejected", "expired", "failed".
channelstringOne of: "agent", "console", "web".
companyNamestringCompany name supplied at signup; shown on the console verification and completion pages.
consentUrlstring (uri)Page where the organization's admin verifies the request (pending_consent only).
activationTokenstringReturned once, by the verifySignupRequest call that performed the verification. Redeem it with createSignupSession after the request is completed.
resultTokenstringReturned only by successful verifySignupRequest. Send as Signup-Result-Token when polling this request to read its result. Valid for one hour; never returned by create, replay, resend or GET.
verificationobjectPresent while the request awaits the emailed code.
verification.requiredboolean
verification.expiresAtstring (date-time)
verification.resendAfterSecondsinteger
verification.sendsRemaininginteger
expiresAtstring (date-time)When an unverified request expires (pending_consent only).
pollAfterSecondsintegerSuggested polling interval while the request is not terminal.
customerIdstringThe provisioned tenant (completed only).
consoleUrlstring (uri)
signInUrlstring (uri)Page where the admin signs into the new tenant (completed only).
tierstringTrial tier name (trial).
trialEndDatestring (date-time)
nextStepsarray of string
reasonobjectWhy a terminal request did not complete.
reason.codestring
reason.detailstring
reason.retryableboolean
Raw JSON schema
{
  "type": "object",
  "description": "Redacted public view of a signup request. Never includes the admin email, the verification code or the idempotency key.",
  "required": [
    "id",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Public request id (sr_ prefix); an unguessable capability."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending_consent",
        "consented",
        "provisioning",
        "completed",
        "rejected",
        "expired",
        "failed"
      ]
    },
    "channel": {
      "type": "string",
      "enum": [
        "agent",
        "console",
        "web"
      ]
    },
    "companyName": {
      "type": "string",
      "description": "Company name supplied at signup; shown on the console verification and completion pages."
    },
    "consentUrl": {
      "type": "string",
      "format": "uri",
      "description": "Page where the organization's admin verifies the request (pending_consent only)."
    },
    "activationToken": {
      "type": "string",
      "description": "Returned once, by the verifySignupRequest call that performed the verification. Redeem it with createSignupSession after the request is completed."
    },
    "resultToken": {
      "type": "string",
      "description": "Returned only by successful verifySignupRequest. Send as Signup-Result-Token when polling this request to read its result. Valid for one hour; never returned by create, replay, resend or GET."
    },
    "verification": {
      "type": "object",
      "description": "Present while the request awaits the emailed code.",
      "properties": {
        "required": {
          "type": "boolean"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        },
        "resendAfterSeconds": {
          "type": "integer"
        },
        "sendsRemaining": {
          "type": "integer"
        }
      }
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "When an unverified request expires (pending_consent only)."
    },
    "pollAfterSeconds": {
      "type": "integer",
      "description": "Suggested polling interval while the request is not terminal."
    },
    "customerId": {
      "type": "string",
      "description": "The provisioned tenant (completed only)."
    },
    "consoleUrl": {
      "type": "string",
      "format": "uri"
    },
    "signInUrl": {
      "type": "string",
      "format": "uri",
      "description": "Page where the admin signs into the new tenant (completed only)."
    },
    "tier": {
      "type": "string",
      "description": "Trial tier name (trial)."
    },
    "trialEndDate": {
      "type": "string",
      "format": "date-time"
    },
    "nextSteps": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "reason": {
      "type": "object",
      "description": "Why a terminal request did not complete.",
      "properties": {
        "code": {
          "type": "string"
        },
        "detail": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        }
      }
    }
  }
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
40921RESOURCE_CONFLICTThe operation conflicts with the resource's current state.
42950RATE_LIMITEDToo many requests. Retryable — the CLI reports the server-provided delay.

Aliases: verifysignuprequest