Sign-up

Where a sign-up request stands, and the API key once the person has confirmed (no API key)

Authenticated by the X-Poll-Token header, the pollToken returned when the request was made. While the person has not confirmed, the status is pending. After they confirm, the first call returns the API key and the status confirmed; every later call returns claimed and no key. Poll about every 5 seconds.

get/signup-requests/{requestId}

Request

  • Base URL: https://realuptime.io/api/v1
  • URL: https://realuptime.io/api/v1/signup-requests/{requestId}
  • Auth: none required

Path parameters

requestIdstring uuid required

The requestId returned by POST /signup-requests.

Headers

X-Poll-Tokenstring required

The pollToken returned by POST /signup-requests.

Response

The request's status. A confirmed response carries apiKey, shown once. A pending response may also mean the address already has an account.

status'pending' | 'confirmed' | 'claimed' | 'declined' | 'expired' required
expiresAtstring
apiKeystring
keyIdstring
keyNamestring
scopesobject
keyExpiresAtstring

Changes

No recorded changes to this operation across all 1 revision of this API.