Synaps Docs
Synaps Docs
Synaps Docs
Synaps Docs
Synaps
Manager
Introduction
Apps
Sessions
Team
Webhooks
Notifications
Integration
Verification Flow
API Integration
Web Integration
Mobile Integration
Know Your Customer
Sessions
Submit Identity Document
Identity Allowed Documents
Submit Residency Document
Residency Allowed Documents
Liveness Verification
Verify Phone Number
Verification Progress
Flow Details
Settings
Know Your Business
Sessions
Create Corporate
Corporate Documents
Corporate Officer Verification
Individual Beneficial Owner
Corporate Beneficial Owner
Submit Corporate
Corporate Details
Corporate Progress
Settings
Auto ID
Sessions
Supported Documents
Verify Document
Details
Certificate
AML
AML Check
Identity Standalone
Session
Submit Document
Details
Verification State
Allowed Documents
References
Country Code (ISO-3166)
Countries
Country calling codes
Nationalities
Rate Limiting
Liveness Details
Powered by GitBook

Residency Allowed Documents

get
Get residency allowed documents

https://workflow-api.synaps.io/v2/workflow/residency/allowed_documents
Get allowed document types
Request
Response
Request
Headers
Session-Id
required
string
Session-Id that you want retrieve info
Response
200: OK
Session information
[
    "UTILITY_BILL",
    "BANK_STATEMENT",
]
400: Bad Request
Invalid Session-Id
{
    "api_code": "SESSION_UNKNOWN",
    "message": "Unknown session"
}

API Response

Returns an array of string containing document type such as :

[
    "UTILITY_BILL",
    "BANK_STATEMENT",
]
Know Your Customer - Previous
Submit Residency Document
Next - Know Your Customer
Liveness Verification
Last updated 12 months ago