Skip to main content
POST
/
auth
/
challenges
/
{challengeId}
/
verified
Verify an authentication challenge
curl --request POST \
  --url https://api.guile.app/auth/challenges/{challengeId}/verified \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'
{
  "authToken": "<string>",
  "refreshToken": "<string>"
}

Path Parameters

challengeId
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Body

application/json

The properties required for verifying an issued authentication challenge.

code
string
required

The one-time passcode used to verify an authentication challenge.

Required string length: 4

Response

Ok. The operation succeeded.

The JSON representation of issued authentication tokens as the result of a successful authentication challenge or the exchange of a refresh token.

authToken
string<jwt>
required

A bearer token representing an authenticated user.

refreshToken
string<jwt>
required

An offline refresh token. Refresh tokens are exchanged for a new authentication token without going through a challenge workflow.