The Verification Flow provides the API workflow for verifying an individual or business and preparing them to transact through your platform. It connects the User, Document, Verification, Ledger, and SubClient APIs to KYC or KYB verification and sets up the verified user for supported payment use cases.
To proceed from creating a user through verification and transaction readiness, refer to the following API sequence.
- Create User API
- Create Document API
- Upload Document to the
urlin Create Document Response - Confirm Upload API
- Retrieve Document API
- Download Document from the
urlin Retrieve Document Response - Create Webook API
- Create Verification API
- Retrieve Verification API
- Create Ledger API
- Create SubClient API v2
%%{init: {
"theme": "base",
"flowchart": {
"htmlLabels": false
},
"themeVariables": {
"primaryTextColor": "#000000",
"secondaryTextColor": "#000000",
"tertiaryTextColor": "#000000",
"lineColor": "#9CA3AF"
},
"themeCSS": ".node text { fill: #000000 !important; }"
}}%%
flowchart TB
A["1. POST - Create User"]
B["2. POST - Create Document"]
C["3. PUT - Upload Document"]
D["4. PUT - Confirm Upload"]
E["5. GET - Retrieve Document"]
F["6. GET - Download Document"]
G["7. POST - Create Webhook"]
H["8. POST - Create Verification"]
I["9. GET - Retrieve Verification"]
J["10. POST - Create Ledger"]
K["11. POST - Create Subclient v2"]
A --> B
B --> C
C --> D
D --> E
E --> F
F --> G
G --> H
H --> I
I --> J
J --> K
classDef post fill:#DBEAFE,stroke:#2563EB,stroke-width:2px,color:#000000
classDef put fill:#FFEDD5,stroke:#EA580C,stroke-width:2px,color:#000000
classDef get fill:#DCFCE7,stroke:#16A34A,stroke-width:2px,color:#000000
class A,B,G,H,J post
class C,D put
class E,F,I get