Send TOTP (2FA, MFA) code to Skyvern

Forward a TOTP (2FA, MFA) email or sms message containing the code to Skyvern. This endpoint stores the code in database so that Skyvern can use it while running tasks/workflows.

Request

This endpoint expects an object.

totp_identifierstringRequired

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

contentstringRequired

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.

task_idstringOptional

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

workflow_idstringOptional

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

workflow_run_idstringOptional

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.

sourcestringOptional

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

expired_atstringOptionalformat: "date-time"

The timestamp when the TOTP code expires

Response

Successful Response

totp_identifierstring

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

contentstring

totp_code_idstring

The skyvern ID of the TOTP code.

codestring

The TOTP code extracted from the content.

organization_idstring

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

created_atstringformat: "date-time"

The timestamp when the TOTP code was created.

modified_atstringformat: "date-time"

The timestamp when the TOTP code was modified.

task_idstring or null

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

workflow_idstring or null

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

workflow_run_idstring or 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.

sourcestring or null

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

expired_atstring or nullformat: "date-time"

The timestamp when the TOTP code expires

1	curl -X POST https://api.skyvern.com/v1/credentials/totp \
2	-H "x-api-key: <x-api-key>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"totp_identifier": "john.doe@example.com",
6	"content": "Hello, your verification code is 123456"
7	}'

1	{
2	"totp_identifier": "john.doe@example.com",
3	"content": "Hello, your verification code is 123456",
4	"totp_code_id": "foo",
5	"code": "foo",
6	"organization_id": "foo",
7	"created_at": "foo",
8	"modified_at": "foo",
9	"task_id": "foo",
10	"workflow_id": "foo",
11	"workflow_run_id": "foo",
12	"source": "foo",
13	"expired_at": "foo"
14	}

Send TOTP (2FA, MFA) code to Skyvern

Headers

Request

Response

Errors