Entregar la credencial del titular y disparar los runs
post /v1/connect/credentials
Entrega la credencial del titular. Es el único punto del sistema por el que entra un secreto en claro; de acá en adelante circula sólo el credential_ref.
Lo llama el widget, nunca tu servidor: la API key no debe llegar al navegador y el
session_token sólo abre su propia sesión.Cuando la sesión guarda la credencial (
credential_policy: "stored"), acepta_terminos es obligatorio y la API rechaza la entrega sin él.Autenticación
Requiere Token de sesión (pk_sess_…) en la cabecera
authorization: Bearer …. Ver autenticación.
Cuerpo de la petición
rut string obligatorio
password string obligatorio
acepta_terminos boolean
terminos_version string
numero_documento string
label string
Respuesta 200
Sesión en ejecución
session_id string obligatorio
status enum obligatorio
createdcredential_pendingverifyingauthorizedin_progresscompletedfailedexpiredrevoked
session_token string
widget_url string
webhook_secret string
credential_ref string | null obligatorio
verification object | null
Por omisión: null
status enum obligatorio
no_iniciadaen_cursoverificadarechazadabloqueadasin_clave_unicano_concluyente
message string | null
Por omisión: null
checked_at string | null
Por omisión: null
runs object[]
Por omisión: []
run_id string obligatorio
flow string obligatorio
flow_version integer obligatorio
status enum obligatorio
queuedrunningawaiting_confirmationsucceededfailedexpiredcancelled
data object | null obligatorio
document object | null obligatorio
type enum obligatorio
pdfjsonscreenshothtml
download_url string obligatorio
expires_at string obligatorio
sha256 string obligatorio
bytes integer obligatorio
documents object[]
Por omisión: []
type enum obligatorio
pdfjsonscreenshothtml
download_url string obligatorio
expires_at string obligatorio
sha256 string obligatorio
bytes integer obligatorio
source_meta object | null obligatorio
driver string obligatorio
obtained_at string obligatorio
portal string obligatorio
portal_ref string
duration_ms integer
attempts integer
error object | null obligatorio
code enum obligatorio
invalid_paramscredential_invalidcredential_expiredportal_unavailableportal_changednot_foundrate_limitedflow_disabledinternal_errorauthentication_errorpermission_deniedconflict
message string obligatorio
execution_token string
execution_token_expires_at string
session_id string | null
parent_run_id string | null
created_at string obligatorio
finished_at string | null obligatorio
expires_at string obligatorio
created_at string obligatorio
Errores
| Código | Cuándo |
|---|---|
400 | Credencial inválida |
El cuerpo de cualquier error sigue la misma forma y su code viene de un
catálogo cerrado. Ver errores.