Referencia de la API

GET /openapi.json

This document

Respuestas

• 200 The OpenAPI document

GET /me

The token's owner and the token itself

Permisos del token: read

Respuestas

• 200 Owner and token

  Nombre	Tipo	Descripción
  id*	string	ULID
  name*	string
  email*	string (email)
  locale*	string
  timezone*	string
  created_at*	string (date-time)
  token*	object|null

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /teams

Teams the user belongs to (their ids go in X-Team-Id)

Permisos del token: read

Parámetros

Respuestas

• 200 A page of teams

  Nombre	Tipo	Descripción
  data*	array<Team>
  links*	object
  meta*	object

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /team

The current team, your role and its plan

Permisos del token: read

Parámetros

Respuestas

• 200 The team, with your role, and its plan in meta

  Nombre	Tipo	Descripción
  data*	Team
  meta*	object

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

PATCH /team

Rename the current team (owner or admin role)

Permisos del token: write

Parámetros

Cuerpo de la petición (JSON)

Respuestas

• 200 The team, with your role, and its plan in meta

  Nombre	Tipo	Descripción
  data*	Team
  meta*	object

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 422 Invalid fields (`validation_failed`); see `errors`

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /flows

List the flows of the team

Permisos del token: flows:read

Parámetros

Respuestas

• 200 A page of flows

  Nombre	Tipo	Descripción
  data*	array<Flow>
  links*	object
  meta*	object

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 422 Invalid fields (`validation_failed`); see `errors`

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /flows/{id}

One flow

Permisos del token: flows:read

Parámetros

Respuestas

• 200 The flow

  Nombre	Tipo	Descripción
  id	string
  name	string
  steps	object
  documents	object|null
  min_age	integer|null
  result_detail	full | minimal
  max_resubmissions	integer
  link_ttl_hours	integer
  locale_default	string
  ready	boolean	Can create sessions (has a privacy policy URL).
  archived	boolean
  archived_at	string|null (date-time)
  created_at	string|null (date-time)

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /sessions

List sessions (newest first, cursor pagination)

Permisos del token: sessions:read

Parámetros

Respuestas

• 200 A page of sessions

  Nombre	Tipo	Descripción
  data*	array<Session>
  links*	object
  meta*	object

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 422 Invalid fields (`validation_failed`); see `errors`

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

POST /sessions

Create a session and get its hosted link

Permisos del token: sessions:write

Parámetros

Cuerpo de la petición (JSON)

Respuestas

• 201 Session created

  Nombre	Tipo	Descripción
  id*	string
  livemode*	boolean
  flow_id*	string
  flow_name	string|null
  external_reference	string|null
  metadata	object|null
  status*	created | in_progress | submitted | in_review | approved | rejected | resubmission_requested | expired | cancelled
  decision	approved | rejected |
  reason_codes	array<string>
  round*	integer
  locale	string
  resubmission_items	array|null
  created_at*	string (date-time)
  expires_at	string|null (date-time)
  submitted_at	string|null (date-time)
  decided_at	string|null (date-time)
  media_purge_at	string|null (date-time)
  url*	string (uri)	The hosted link. Shown only here and in `POST /sessions/{id}/link`.
  qr_svg_url*	string (uri)	Signed URL of an SVG QR code of the link, valid 15 minutes.
  embed*	object
  invite	queued | suppressed |

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 422 Invalid fields (`validation_failed`); see `errors`

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /sessions/{id}

One session: status, decision, reason codes, subject fields, checks and timeline (no media)

Permisos del token: sessions:read

Parámetros

Respuestas

• 200 The session

  Nombre	Tipo	Descripción
  id*	string
  livemode*	boolean
  flow_id*	string
  flow_name	string|null
  external_reference	string|null
  metadata	object|null
  status*	created | in_progress | submitted | in_review | approved | rejected | resubmission_requested | expired | cancelled
  decision	approved | rejected |
  reason_codes	array<string>
  round*	integer
  locale	string
  resubmission_items	array|null
  created_at*	string (date-time)
  expires_at	string|null (date-time)
  submitted_at	string|null (date-time)
  decided_at	string|null (date-time)
  media_purge_at	string|null (date-time)
  result	object|null	Present once decided. A minimal-result flow only carries the `age_over_*` booleans.
  checks	object|null	Flag names of the latest automatic pre-check; never metrics.
  timeline	array<object>

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

DELETE /sessions/{id}

Erase the session and its media now (data-subject erasure)

Permisos del token: sessions:write

Parámetros

Respuestas

• 204 Erased
• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

POST /sessions/{id}/cancel

Cancel a session that has not been submitted

Permisos del token: sessions:write

Parámetros

Respuestas

• 200 The cancelled session

  Nombre	Tipo	Descripción
  id*	string
  livemode*	boolean
  flow_id*	string
  flow_name	string|null
  external_reference	string|null
  metadata	object|null
  status*	created | in_progress | submitted | in_review | approved | rejected | resubmission_requested | expired | cancelled
  decision	approved | rejected |
  reason_codes	array<string>
  round*	integer
  locale	string
  resubmission_items	array|null
  created_at*	string (date-time)
  expires_at	string|null (date-time)
  submitted_at	string|null (date-time)
  decided_at	string|null (date-time)
  media_purge_at	string|null (date-time)
  result	object|null	Present once decided. A minimal-result flow only carries the `age_over_*` booleans.
  checks	object|null	Flag names of the latest automatic pre-check; never metrics.
  timeline	array<object>

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 409 The session is in a status that does not allow this (`not_cancellable`, `not_relinkable`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

POST /sessions/{id}/link

Issue a new hosted link (the old one stops working)

Permisos del token: sessions:write

Parámetros

Respuestas

• 200 The session with its new link

  Nombre	Tipo	Descripción
  id*	string
  livemode*	boolean
  flow_id*	string
  flow_name	string|null
  external_reference	string|null
  metadata	object|null
  status*	created | in_progress | submitted | in_review | approved | rejected | resubmission_requested | expired | cancelled
  decision	approved | rejected |
  reason_codes	array<string>
  round*	integer
  locale	string
  resubmission_items	array|null
  created_at*	string (date-time)
  expires_at	string|null (date-time)
  submitted_at	string|null (date-time)
  decided_at	string|null (date-time)
  media_purge_at	string|null (date-time)
  url*	string (uri)	The hosted link. Shown only here and in `POST /sessions/{id}/link`.
  qr_svg_url*	string (uri)	Signed URL of an SVG QR code of the link, valid 15 minutes.
  embed*	object
  invite	queued | suppressed |

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 409 The session is in a status that does not allow this (`not_cancellable`, `not_relinkable`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /sessions/{id}/export

Data-subject access export (JSON, no media binaries)

Permisos del token: sessions:read

Parámetros

Respuestas

• 200 Everything held about the session
• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 404 Not found, including a team you are not a member of (`team_not_found`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /usage

Billable verifications of the current month

Permisos del token: sessions:read

Parámetros

Respuestas

• 200 Usage

  Nombre	Tipo	Descripción
  period	string (date)	First day of the billing month.
  included	integer|null
  used	integer
  overage	integer
  cap	integer|null

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

GET /webhook-deliveries

Delivery status of webhooks, for debugging (no payloads)

Permisos del token: webhooks:read

Parámetros

Respuestas

• 200 A page of deliveries

  Nombre	Tipo	Descripción
  data*	array<WebhookDelivery>
  links*	object
  meta*	object

• 400 You belong to several teams and sent no X-Team-Id (`team_required`), or a token was sent in the query string (`token_in_query`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 401 No token, an unknown, expired or revoked one, or its owner is suspended (`unauthenticated`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 403 The token lacks the ability (`missing_ability`), the role doesn't allow it (`forbidden`), the plan has no API access or the team is suspended (`team_suspended`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 422 Invalid fields (`validation_failed`); see `errors`

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

• 429 Rate limit of the token's plan reached (`rate_limited`)

  Nombre	Tipo	Descripción
  type*	string
  title*	string
  status*	integer
  detail*	string
  code*	string	Stable machine-readable reason.
  request_id*	string|null	Quote it when contacting support.
  errors	object	Only on 422: field → messages.

sessionEvent

Event sent to your endpoint (configure it in Developers → Webhooks)