v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB

SDK

Verify payload and return JWT

post/sdk/{environmentId}/verify

Path parameters

environmentIdstring required

Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

signedMessagestring required

messageToSignstring required

publicWalletAddressstring required

walletNamestring required

skipEmptyAccountCheckboolean

Used for wallet transfers. When set to true it will execute the transfer even if the wallet is the only one that the transferor has.Be warn that this will result an orphan account that will be impossible to access.

captchaTokenstring

When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.

networkstring

backupstring

passwordstring

passwordSource'dynamic' | 'user'

sessionPublicKeystring

Example request

{
  "signedMessage": "signed message",
  "messageToSign": "message to sign",
  "publicWalletAddress": "An example name",
  "walletName": "An example name",
  "network": "An example name",
  "backup": "An example name",
  "sessionPublicKey": "An example name"
}

Response

Successful verify response, that contains the encoded JWT as a string.

mfaTokenstring

jwtstring

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

minifiedJwtstring

Encoded JWT token. This will only be returned when cookie-based authentication is disabled in favor of standard Auth header based authentication.

expiresAtnumber required

Format is a unix-based timestamp. When set, this will be the expiration timestamp on the JWT sent using either the jwt field or a response httpOnly cookie set by the server.

Example response

{
  "jwt": "jwt_value",
  "user": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "verifiedCredentials": [
      {
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "refId": "95b11417-f18f-457f-8804-68e361f9164f",
        "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "wallet_properties": {
          "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f"
        },
        "phoneNumber": "9171113333",
        "phoneCountryCode": "1",
        "isoCountryCode": "US",
        "previous_users": [
          "95b11417-f18f-457f-8804-68e361f9164f"
        ]
      }
    ],
    "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
    "alias": "An example name",
    "country": "US",
    "firstName": "An example name",
    "jobTitle": "An example name",
    "lastName": "An example name",
    "tShirtSize": "An example name",
    "team": "An example name",
    "username": "An example name",
    "scope": "superuser marketing operations",
    "missingFields": [
      {
        "validationRules": {
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        }
      }
    ]
  },
  "minifiedJwt": "jwt_value"
}