Les quatre accepten la teva clau d’API del client o una capçalera d’autorització d’usuari, i les quatre emeten un webhook
data.updated quan l’operació és satisfactòria, perquè el teu sistema i les analítiques posteriors continuïn sincronitzats.
Requisits comuns
- Autorització: clau d’API del client (
x-api-key/Authorizationbearer estàndard) o token d’usuari. - Privilegi:
- KYC i POA:
write:sessions - Empresa KYB i part del grup de persones clau:
write:businesses
- KYC i POA:
- Estat de la sessió (només KYC / POA): ha de ser un dels següents:
APPROVED,DECLINED,IN_REVIEWoKYC_EXPIRED. Les sessions que no han arribat a un estat revisable no es poden corregir. Les actualitzacions de l’empresa KYB no tenen cap restricció d’estat. - El registre de la funcionalitat ha d’existir: només pots corregir camps KYC si la sessió ha capturat un KYC, camps POA si ha capturat un POA, i camps de l’empresa KYB si la sessió té una comprovació de registre.
- Actualitzacions parcials: només es canvien els camps que inclous. Si n’omets un, es deixa tal com està. Envia
nullper esborrar una clau deextra_fields. - Webhooks: una actualització satisfactòria activa
data.updatedambsession_kind: "user"o"business", i el registre d’auditoria de la sessió indica quins camps concrets han canviat i qui els ha canviat.
Actualitzar les dades d’identitat KYC
PATCH /v3/session/{sessionId}/update-data/
Corregeix qualsevol camp extret del document d’identitat. Admet fluxos de treball multi-instància basats en un graf mitjançant el paràmetre de consulta opcional node_id o un camp del cos: indica un registre KYC concret quan una sola sessió té diversos passos KYC.
Camps modificables
parsed_address només accepta aquestes claus imbricades: address_type, city, region, street_1, street_2, postal_code, country (ISO 3166-1 alpha-2).
Exemple
?node_id=feature_ocr_2 a la URL (o passa "node_id": "feature_ocr_2" al cos) per indicar un registre KYC concret.
Actualitzar les dades del comprovant de domicili (POA)
PATCH /v3/session/{sessionId}/update-poa-data/
Corregeix els camps extrets d’un document de comprovant de domicili. Les mateixes restriccions d’estat i el mateix privilegi que les actualitzacions KYC. També admet node_id per a fluxos de treball multi-instància.
Camps modificables
Exemple
Actualitza les dades de l’empresa KYB
PATCH /v3/session/{sessionId}/kyb/{companyUuid}/update-data/
Corregeix els camps extrets del registre d’una empresa KYB. L’endpoint edita tant les columnes canòniques de l’empresa com registry_data, de manera que la vista «Extret del registre» de la consola reflecteix les teves correccions. user_provided_data (el que l’usuari final va confirmar al flux allotjat) no es modifica. S’hi registra last_console_edit_at i s’activa un webhook data.updated amb trigger: "console_registry_edit".
Requisits
- Privilegi:
write:businesses(diferent del privilegi de KYC / POA). - El
companyUuidde la URL ha de pertànyer alsessionIdindicat; si no, obtindràs un 404. - No hi ha cap restricció per estat de la sessió: les dades de l’empresa KYB es poden corregir en qualsevol moment.
Camps modificables
Qualsevol camp que ometis es deixa sense canviar. Qualsevol camp que enviïs s’escriu a la columna canònica (quan n’existeix una) i es fusiona amb
registry_data. Les dates es serialitzen com a cadenes ISO 8601 quan es fusionen amb registry_data.
Exemple
registry_checks[].company a la decisió de la sessió.
Omet una part de Key People
PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/
Eximeix una part de Key People de la verificació: és la via d’escapament per a una part que mai no podrà completar la seva pròpia comprovació. La causa habitual és una sessió filla eliminada. Quan la KYC individual assignada a un UBO o a un administrador s’elimina, el seu estat es congela i mai no es resoldrà, de manera que el KYB no té res que pugui fer-la sortir de Awaiting User. En ometre la part, aquesta deixa de comptar a l’agregació de Key People, la comprovació es recalcula a l’instant i la sessió es pot resoldre i aprovar o rebutjar.
Requisits
- Privilegi:
write:businesses. - El
partyUuidde la URL ha de pertànyer alsessionIdindicat; si no, obtindràs un 404. - No està condicionat per
allow_skip. Aquesta configuració del rol limita el que el sol·licitant pot ometre mentre omple la pantalla allotjada de Key People. Aquest endpoint és la sobreescriptura de l’operador, de manera que funciona fins i tot en rols en què el sol·licitant no hauria pogut ometre la part.
Cos
requires_verification no es modifica intencionadament, de manera que una part a la qual s’ha aplicat l’excepció apareix com a requires_verification: true i is_skipped: true. El registre continua mostrant que les regles demanaven una comprovació.
Exemple
key_people_checks[].submitted.parties[] a la decisió de la sessió.
S’activa un webhook data.updated amb trigger: "console_key_people_skip".
Una part la sessió filla de la qual s’ha eliminat es marca al payload de la decisió amb
kyc_session_deleted: true (o kyb_sub_session_deleted: true per a les parts corporatives),
i el seu kyc_session_url / kyb_sub_session_url es retorna com a null perquè l’enllaç ja no es resol.
Eliminar una sessió filla mai no aprova la part per si sola: la comprovació de Key People passa a In Review
perquè una persona prengui la decisió.Què passa després d’una actualització
- Webhook:
data.updateds’activa sobre la sessió, amb elsession_kindde la sessió al payload ("user"o"business"). Subscriu-te una sola vegada al nivell de destinació i encamina segonssession_kind. - Registre d’auditoria: la sessió registra exactament quins camps han canviat, els valors anterior i nou, i (per a les crides amb autenticació d’usuari) el correu electrònic de l’actor. Es pot consultar a la pestanya Events de la consola.
- Tornar a geocodificar l’adreça: per a les actualitzacions KYC i POA que canvien
address/poa_address, Didit repeteix la geocodificació en segon pla. Els errors s’ignoren perquè l’actualització mai no falli per un problema de geocodificació. - Reavaluació AML: les actualitzacions KYC que canvien el nom, la data de naixement o la nacionalitat poden tornar a activar el cribratge AML si aquest no havia acabat a la sessió. Els resultats apareixen a la decisió de la sessió.
Quan no cal fer servir aquests endpoints
- Repetir tota la verificació: si el client ha de tornar a fer la foto del document d’identitat o tornar a pujar un document, fes servir update-status per passar la sessió a
Resubmitted. - Canviar camps de perfil de l’entitat User o Business: fes servir
PATCH /v3/users/{vendor_data}/oPATCH /v3/businesses/{vendor_data}/. Aquests endpoints actualitzen dades a nivell d’entitat, no a nivell de sessió. - Editar dades de Key People: no hi ha cap API pública per modificar el nom, els rols o la titularitat d’una part. Aquestes dades s’envien mitjançant el flux allotjat. L’únic camp modificable és
is_skipped(vegeu Omet una part de Key People).
Errors
Passos següents
Recuperar la sessió
Obtén la decisió completa per veure els camps actualitzats.
Actualitzar l'estat
Aprova, rebutja o reobre una sessió després d’una correcció de dades.
Webhooks
Subscriu-te als esdeveniments
data.updated.