Synaps
Search…
Proof of Residency
post
https://individual-api.synaps.io
/v3/residency/submit
Submit Proof of Residency document
post
https://individual-api.synaps.io
/v3/residency/submit
get
https://individual-api.synaps.io
/v3/residency/details
Get proof of residency verification details
API Response

ResidencyVerificationResponse | Object

Field
Type
Description
document
ResidencyDocument | Object
Proof of residency document
history
ResidencyHistory | Array
verification history
state
string
Verification state
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED

ResidencyVerificationDocument | Object

Field
Type
Description
document
ResidencyDocument | Object
country calling code (see country calling codes reference)
is_accomodation
boolean
true if accomodation proof
false if no accomodation proof
state
string
Verification state
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED
info
ResidencyInfo | Object
Residency details of the user

ResidencyDocument | Object

Field
Type
Description
type
string
Document type
ELECTRICITY_BILL
GAS_BILL
LANDLINE_BILL
WATER_BILL
INTERNET_BILL
BANK_STATEMENT
filetype
string
Filetype
application/pdf
image/jpeg
image/png
file
string
image of the document available through a signed URL (15 minutes expiry)

ResidencyInfo | Object

Field
Type
Description
firstname
string
User firstname
lastname
string
User lastname
address
string
Postal address
country
string
Country of residence
city
string
City of residence
zipcode
string
Zip Code (might be empty)
issuing_date
string
Date format YYYY-MM-DD

ResidencyHistory | Object

Field
type
Description
user_reason
string
User reason is a reason that you should display to your end-user
customer_reason
string
Customer reason is an internal reason and it should not be displayed to your end-user
rejection_code
string
Synaps rejection code
submitted_at
string
Datetime format YYYY-MM-DD hh:ii:ss
verified_at
string
Datetime format YYYY-MM-DD hh:ii:ss
state
string
Verification state
VALIDATED
FINAL_REJECTED REJECTED
NOT_STARTED
Last modified 22d ago