LeapCat KYC Verification Skill
Guide a user through the full Know Your Customer (KYC) verification process using the leapcat. Covers document upload, personal information submission, agreements, and status polling.
Prerequisites
- Node.js 18+ is required (commands use which auto-downloads the CLI)
- User must be authenticated — run
npx leapcat@latest auth login --email <email>
- Identity document images (e.g., passport, national ID) must be available as local files
Commands
upload (file upload utility)
Upload an image file and receive a URL + key for use in subsequent KYC commands.
bash
npx leapcat@latest upload --file <path-to-file> --json
Parameters:
- — Path to a local image file (JPG, PNG, PDF)
Response:
json
{ "url": "https://...", "key": "uploads/..." }
kyc status
Check the current KYC verification status.
bash
npx leapcat@latest kyc status --json
kyc detail
Get detailed KYC information including submitted data and review notes.
bash
npx leapcat@latest kyc detail --json
kyc consent
Submit user consent to begin the KYC process.
bash
npx leapcat@latest kyc consent --json
kyc documents
Submit identity document information (type, URLs from upload).
bash
npx leapcat@latest kyc documents --json
Parameters (interactive or via stdin):
- Document type (e.g., PASSPORT, NATIONAL_ID)
- Front image URL (from command)
- Back image URL (from command, if applicable)
kyc personal-info
Submit personal information (name, date of birth, address, etc.).
bash
npx leapcat@latest kyc personal-info --json
kyc supplementary
Submit supplementary documents if requested during review.
bash
npx leapcat@latest kyc supplementary --json
kyc agreements
Accept the required legal agreements and disclosures.
bash
npx leapcat@latest kyc agreements --json
kyc submit
Submit the completed KYC application for review.
bash
npx leapcat@latest kyc submit --json
Workflow
- Check status — Run to see where the user is in the KYC process.
- Consent — If status is , run to begin.
- Upload documents — Upload each identity document image:
bash
npx leapcat@latest upload --file ./id-front.jpg --json
npx leapcat@latest upload --file ./id-back.jpg --json
- Submit document metadata — Run and provide the document type and uploaded URLs.
- Personal information — Run and fill in user details.
- Supplementary documents (optional) — If the KYC status indicates supplementary docs are needed, upload and submit via .
- Agreements — Run to accept legal terms.
- Submit for review — Run to finalize the application.
- Poll status — Periodically run until the status changes to or .
Error Handling
| Error | Cause | Resolution |
|---|
| Session expired | Re-authenticate with |
| KYC application already under review | Wait for review; check with |
| KYC already completed | No action needed — user is verified |
| Uploaded file is unreadable or wrong format | Re-upload with a clearer image |
| Required personal info fields are empty | Re-run with all required fields |
| File upload error | Retry ; check file path and format |