Credentials

Send TOTP code

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.

post/v1/credentials/totp

Headers

x-api-keystring nullable

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

Request body

totp_identifierstring required

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

task_idstring nullable

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 nullable

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 nullable

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 nullable

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

contentstring 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.

expired_atstring date-time nullable

The timestamp when the TOTP code expires

type'totp' | 'magic_link'

Example request

{
  "totp_identifier": "john.doe@example.com",
  "task_id": "task_123456",
  "workflow_id": "wpid_123456",
  "workflow_run_id": "wr_123456",
  "source": "email",
  "content": "Hello, your verification code is 123456",
  "expired_at": "2025-01-01T00:00:00Z"
}

Response

Successful Response

totp_identifierstring required

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

task_idstring nullable

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 nullable

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 nullable

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 nullable

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

contentstring required

expired_atstring date-time nullable

The timestamp when the TOTP code expires

type'totp' | 'magic_link'

totp_code_idstring required

The skyvern ID of the TOTP code.

codestring required

The TOTP code extracted from the content.

organization_idstring required

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

created_atstring date-time required

The timestamp when the TOTP code was created.

modified_atstring date-time required

The timestamp when the TOTP code was modified.

otp_type'totp' | 'magic_link'

Example response

{
  "totp_identifier": "john.doe@example.com",
  "task_id": "task_123456",
  "workflow_id": "wpid_123456",
  "workflow_run_id": "wr_123456",
  "source": "email",
  "content": "Hello, your verification code is 123456",
  "expired_at": "2025-01-01T00:00:00Z"
}

Changes

Changed in 5 of the 86 revisions of this API.1721

Jul 31, 202689dbd6fd08fb2See the full diff
- ○
  request property deprecated
  request-property-deprecated
- ○
  response property type deprecated
  response-property-deprecated
Jul 30, 20265fc42058bb741See the full diff
- ▲
  removed the success response with the status
  response-success-status-removed
Jul 30, 20264f040669f1512See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the success response with the status
  response-success-status-added
Jun 8, 20263a3616091b661616See the full diff
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  removed the enum value magic_link of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value totp of the request property
  request-property-enum-value-removed
- ▲
  the request property type changed from string to no type
  request-property-type-changed
- ▲
  response property expired_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property source list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property task_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property workflow_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property workflow_run_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the response's property type changed from string to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from string to no type for status
  response-property-type-changed
- ○
  header request parameter x-api-key list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  for the header request parameter x-api-key, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  added subschema #2 to the request property anyOf list
  request-property-any-of-added
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed the magic_link enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the magic_link enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the totp enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the totp enum value from the response property for the response status
  response-property-enum-value-removed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 2026a8899e7707c41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history