API reference
Interview
- Delete PII data for single onboarding session.DELETE
- Start onboardingPOST
- Request new onboarding for integrationsPOST
- Fetch imagesPOST
- Fetch image linksPOST
- Fetch images second idPOST
- Fetch image links for second idPOST
- Fetch concatenated imagesPOST
- Fetch scoresGET
- Fetch device infoGET
- Get url to download session recordingGET
- Delete PII data for multiple onboarding sessions with multiple options.DELETE
- Fetch onboarding statusGET
- Send SMS with the link for onboardingPOST
- Fetch onboarding urlGET
- Update manual reviewPUT
- Approve customerPOST
- Delete PII data for single onboarding session by external ID.DELETE
- Update interviewPUT
- Add QR code raw textPOST
- Set session statusPOST
- Get session statusGET
- Mark onboarding completeGET
- Mark onboarding completePOST
- Process IMSSPOST
- Process payment proofPOST
- Fetch IMSS labor historyGET
- Fetch interview event dictionaryGET
- Fetch interview eventsGET
- Generates single session PDF reportPOST
- Add custom watchlist entries for child organizationsPOST
- Fetch session listingGET
- Fetch device info listGET
- Start onboarding internalPOST
- Refresh QR code valuePOST
- Validate QR code uuidPOST
- Import base64Video and return recordingIdPOST
- Import base64Video and return recordingIdPOST
- Fetch raw IDV resultsGET
- Continue onboarding sessionPOST
Antifraud
API validations
- Fetch CURP scraping resultsGET
- Fetch INE scraping resultsGET
- Validate bank statementPOST
- Validate bank statement v2POST
- CURP scraping validation by dataPOST
- CURP scraping validationPOST
- INE scraping validationPOST
- Registraduria validation - Colombian idPOST
- Colombia - Temporary Residency / PPT ValidationPOST
- RFC validation by CURP v2POST
- RFC validationPOST
- Calculate RFCPOST
- SSN ValidationPOST
- Vehicle Identification Number ValidationPOST
Authentications
Curp validation
Custom fields
Custom watchlist
Document capture
eKYB
eKYC
Electronic signature
Electronic signature (advanced)
Face capture
Fiscal QR URL
Forms and data entry
Frame analysis
Geolocation
- Add geolocationPOST
Global watchlist
Government validation
Id capture
- Add front side of IDPOST
- Add front side of Second IDPOST
- Add back side of IDPOST
- Add back side of Second IDPOST
- Process IdPOST
- Process Second IdPOST
- Add document idPOST
- Get ID SummaryGET
- Fetch ocr dataGET
- Fetch ocr data v2GET
- Fetch ocr data for second idGET
- Update editable OCR data in interviewPUT
- Update editable OCR data in interview for the second IdPUT
- Add BarcodePOST
- Get cross-document comparison resultsGET
- Add Base64 BarcodePOST
- Add Base64 BarcodePOST
Identity reuse
NOM-151
Onboarding
- Add device fingerprintPOST
- Add device fingerprint signalsPOST
- Forward diagnostics dataPOST
- Add fingerprintsPOST
- Add namePOST
- Send SMS with One Time Password for onboardingGET
- FetchGET
- CreatePOST
- UpdatePUT
- Attach signature to pdf documentPOST
- Fetch Identity dataGET
- Insert authentications in batchPOST
- Generate interview codeGET
- Verify interview codePOST
- Compare/Validate OTP code obtained through SMS for onboardingGET
- Delete Multiple onboarding sessions with multiple options.POST
- Update device statsPOST
- Expire onboarding sessions by interviewIds.POST
- Get FingerprintsGET
- Fetch processing statusGET
- Fetch random questions and answers for video selfieGET
- Identity cross-check comparing account creation data with IDV dataPOST
- Fetch all passed onboardings ids for the same personGET
- Perform MFAPOST
- Send SMS with One Time Password for onboardingGET
- Publish session events to Kafka for a batch of interview IDsPOST
- Compare OCR from videoselfie against OCR from ID v2POST
- Issue a device-bound mDL for the current interviewPOST
Onboarding authentication
Organization
Proof of address capture
Shared consent
User consent
Video conference
- Save user consentPOST
- Add conference modulePOST
- Add conference feedbackPOST
- Add notesPOST
- Send conference chatPOST
- Add conference eventPOST
- Fetch conference eventsGET
- Store conference photosPOST
- Report conference issuePOST
- Finish interviewPUT
- Fetch notesGET
- Fetch conference feedbackGET
- Fetch conference chatGET
- Fetch conference statusGET
- Fetch video archive urlsGET
- Connect to conference callGET
- Add user to queuePUT
- Get connection detailsGET
- Disconnect user from the queuePOST
- Get user's position in queueGET
- Get next customer from the queueGET
- Start recordingPOST
- Stop recordingPOST
- Verify facePOST
- Add notesPOST