Skip to main content
POST
/
v1
/
credentials
/
totp
Send TOTP code
curl --request POST \
  --url https://api.skyvern.com/v1/credentials/totp \
  --header 'Content-Type: application/json' \
  --data '
{
  "totp_identifier": "john.doe@example.com",
  "content": "Hello, your verification code is 123456",
  "task_id": "task_123456",
  "workflow_id": "wpid_123456",
  "workflow_run_id": "wr_123456",
  "source": "email",
  "expired_at": "2025-01-01T00:00:00Z",
  "type": "totp"
}
'
{
  "totp_identifier": "john.doe@example.com",
  "content": "Hello, your verification code is 123456",
  "totp_code_id": "<string>",
  "code": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "task_id": "task_123456",
  "workflow_id": "wpid_123456",
  "workflow_run_id": "wr_123456",
  "source": "email",
  "expired_at": "2025-01-01T00:00:00Z",
  "type": "totp",
  "otp_type": "totp"
}

Headers

​
x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Body

application/json
​
totp_identifier
string
required

The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.

Example:

"john.doe@example.com"

​
content
string
required

The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content.

Example:

"Hello, your verification code is 123456"

​
task_id
string | null

The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for.

Example:

"task_123456"

​
workflow_id
string | null

The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for.

Example:

"wpid_123456"

​
workflow_run_id
string | null

The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for.

Example:

"wr_123456"

​
source
string | null

An optional field. The source of the TOTP code. e.g. email, sms, etc.

Example:

"email"

​
expired_at
string<date-time> | null

The timestamp when the TOTP code expires

Example:

"2025-01-01T00:00:00Z"

​
type
enum<string> | null

Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract.

Available options:
totp,
magic_link
Example:

"totp"

Response

Successful Response

​
totp_identifier
string
required

The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user.

Example:

"john.doe@example.com"

​
content
string
required

The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content.

Example:

"Hello, your verification code is 123456"

​
totp_code_id
string
required

The skyvern ID of the TOTP code.

​
code
string
required

The TOTP code extracted from the content.

​
organization_id
string
required

The ID of the organization that the TOTP code is for.

​
created_at
string<date-time>
required

The timestamp when the TOTP code was created.

​
modified_at
string<date-time>
required

The timestamp when the TOTP code was modified.

​
task_id
string | null

The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for.

Example:

"task_123456"

​
workflow_id
string | null

The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for.

Example:

"wpid_123456"

​
workflow_run_id
string | null

The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for.

Example:

"wr_123456"

​
source
string | null

An optional field. The source of the TOTP code. e.g. email, sms, etc.

Example:

"email"

​
expired_at
string<date-time> | null

The timestamp when the TOTP code expires

Example:

"2025-01-01T00:00:00Z"

​
type
enum<string> | null

Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract.

Available options:
totp,
magic_link
Example:

"totp"

​
otp_type
enum<string> | null

The type of the OTP code.

Available options:
totp,
magic_link