For AI agents: visit https://docs.urbanpayx.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API Reference
v1.0.812
API Reference
Log In
Jump to Content
v1.0.812
API Reference
My Requests
Log In
JUMP TO
Overview
Client Login
My Requests
Authentication Guide
Sandbox and Testing
Client Login
Core Concepts
Transaction Lifecycle
KYC Verification Guide
Roles and Permissions
Integration Tutorial
Webhook Event Catalog
Architecture Diagrams
Launch Checklist
Pagination
Changelog and Versioning
Error Reference
Rate limits
MCP Server
Integration Prompt
KYB Verification Guide
UrbanpayX
Payment Initiation
Recurring Payments
Create Recurring Payment
post
List Recurring Payments
get
Get Recurring Payment
get
Update Recurring Payment
patch
Disable Recurring Payment
post
Enable Recurring Payment
post
Retry Recurring Payment
post
Sandbox Credentials (Bank)
Generate Payment Link
post
Cancel Payment Intent
post
Transactions
Get Transaction
get
List Transactions
get
Refresh Transaction Status
post
Get Transactions Summary
get
Contracts Signing
Use dynamic content variables in DOCX to create personalized documents
Contract Template
Resend Contract Invitation Email
post
Refresh Contract Template
post
Delete Contract Template
del
Get Contract Template Preview Content
get
Get Contract Template Preview
get
List Contract Templates
get
Create Contract Template
post
Get Contract Template
get
Create Contract Builder Session
post
Signing Profile
Delete Signing Profile Initials Image
del
Delete Signing Profile Signature Image
del
Get Signing Profile
get
Upsert Signing Profile
put
Workflow
Delete Workflow
del
List Workflows
get
Create Workflow
post
Update Workflow
put
Get Workflow
get
Contract Request
List Contract Requests
get
Create Contract Request
post
Bind Contract Request Transaction
post
Cancel Contract Request
post
Get Contract Request
get
Reconcile Contract Request
post
Compose And Send Contract
post
Download Contract Request Document
get
Download Contract Request Audit Log
get
Get Contract Requests Summary
get
Authentication
API & Credentials
Get API Token
post
Refresh API Key
post
Create API Credential
post
List API Credentials
get
Disable API Credential
post
Delete API Credential
del
Reset API Credential Secret
post
Delete Client Passkey
del
Update Checkout Branding
put
Update My Team Account
patch
Client Webhooks
List Webhook Events
get
Get Webhook Subscription
get
Upsert Webhook Subscription
put
Rotate Webhook Secret
post
Send Test Webhook Event
post
List Webhook Deliveries
get
Get Webhook Delivery
get
List Webhook Destinations
get
Create Webhook Destination
post
Update Webhook Destination
put
Delete Webhook Destination
del
Rotate Webhook Destination Secret
post
Send Destination Test Event
post
Retry Webhook Event
post
Custom Verification Workflows
List Modules
get
List Custom Levels
get
Create Custom Level
post
Replace Custom Level
put
Delete Custom Level
del
List Modules
get
List Custom Levels
get
Create Custom Level
post
Replace Custom Level
put
Delete Custom Level
del
KYC Verification
Verification
Initiate KYC Verification
post
Request KYC Resubmission
post
KYC Manual Review
post
List KYC Levels
get
Results
Get KYC Status
get
Get KYC Decision
get
Get KYC Verification Detail
get
Get KYC Verification Detail History
get
Download KYC Verification Document
get
Download KYC Questionnaire File
get
Get KYC Status Summary
get
External attestation
Update External Verification Status
post
Bulk Update External Verification Status
post
KYB Verification
Verification
Initiate KYB Verification
post
Request KYB Resubmission
post
List KYB Levels
get
Results
Get Business KYB Status
get
Get KYB Decision
get
Get KYB Verification Detail
get
Get KYB Verification Detail History
get
Download KYB Verification Document
get
Get KYB Status Summary
get
External attestation
Update Business External Verification Status
post
Download KYB Company Document
get
Users
Create User
post
Bulk Create Users
post
Update User Profile
patch
Update User Verification Mode
patch
Activate User
post
Deactivate User
post
List Users KYC Status
get
Wallet Screening (KYT)
Wallet Screening
post
Get Wallet Screening
get
List Wallet Screenings
get
Request a wallet ownership proof
post
List wallet ownership proof requests
get
Cancel a wallet ownership proof request
post
Transaction Monitoring
Submit Transaction for Monitoring
post
List Monitored Transactions
get
Get Monitored Transaction
get
Get Monitoring Policy
get
Update Monitoring Policy
put
Travel Rule
Submit a Travel Rule transfer
post
List Travel Rule Transfers
get
Get Travel Rule Transfer
get
Business Customers
Create Business Customer
post
List Business Customers
get
Update Business Customer
patch
Update Business Verification Mode
patch
Activate Business Customer
post
Deactivate Business Customer
post
Projects
Create Project
post
Update Project
put
Get Project
get
List Projects
get
Operation Companies
Create Opco
post
List Opcos
get
Get Opco
get
Update Opco Draft
patch
Submit Opco
post
Workflows
Workflow Runs
List Workflow Runs
get
Get Workflow Run
get
Retry Workflow Run
post
Cancel Workflow Run
post
Refresh Workflow Run Status
post
Workflow Triggers
Trigger Workflow Run
post
Create Workflow
post
List Workflows
get
Fork Workflow
post
Publish Workflow
post
Rotate Workflow Trigger Secret
post
Start Workflow Run
post
Update Workflow
put
Delete Workflow
del
Get Workflow
get
UrbanPay
KYB Verification
KYB Manual Review
post
Payment Schedules
Create Payment Schedule
post
List Payment Schedules
get
Preview Payment Schedule
post
Get Payment Schedule
get
Update Payment Schedule
patch
Cancel Payment Schedule
post
Update Payment Schedule Item
patch
Skip Payment Schedule Item
del
Insert Payment Schedule Item
post
Send Payment Schedule Item Now
post
Remind Payment Schedule Item
post
Powered by
••••••8134
Endpoint
Method
Status
User Agent