Cancel an ID Pass API
/idpass/cancel
Cancels an in-flight ID Pass. Only passes in new, opened or in_progress status can be cancelled. Terminal statuses (complete, expired, failed, cancelled) return an error. A fee refund applies if no verification steps had been taken yet (status still new or opened). Cancelling after any verification activity doesn't refund.
Example Request
POSTRequest Schema
id
The ID Pass to cancel.
Available Response Data
3 Data Pointsstatus: always cancelled on success
fee_refunded: true when no verification steps had been taken, false otherwise
API reference UUID
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Technical Use Cases tag
Cleaning up abandoned applications
When a customer abandons their application before completing identity verification, cancel the outstanding ID Pass to release the slot and recover the fee where eligible.
Superseding a prior pass
When a workflow re-issues an ID Pass with different parameters (for example, the customer's visa status changed), cancel the prior pass so it doesn't accidentally complete in parallel.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
When does a fee refund apply?
add
When does a fee refund apply?
Only when the ID Pass is still in new or opened status at the time of cancellation — meaning no verification steps were taken. Once the user has progressed beyond consent (status in_progress), no refund is issued.
rocket_launch Implementation
Can I cancel a completed pass?
add
Can I cancel a completed pass?
No. Terminal statuses (complete, expired, failed, cancelled) return a 400. Cancellation only applies to in-flight passes.
API Testing Sandbox tag
Test the Cancel an ID Pass API directly in your browser with live mock data and see instant results.
rocket_launch Request Sandbox AccessAccess to live sandbox environments requires manual approval from our compliance team.
Ready to integrate Cancel an ID Pass API?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.