Proof of Residency

Submit Proof of Residency document

POST https://individual-api.synaps.io/v3/residency/submit

Send a residency document to verification

Query Parameters

Name	Type	Description
step_id	string	Step Id of the current identity step you want to submit

Headers

Name	Type	Description
Session-Id	string	Initialized Session-Id

Request Body

Name	Type	Description
host_id_back_document	object	Back Host ID document (image/jpg, image/jpeg, image/png)
host_id_front_document	object	Front Host ID document (image/jpg, image/jpeg, image/png)
host_id_document_type	string	ID type PASSPORT NATIONAL_ID RESIDENT_PERMIT DRIVER_LICENSE
host_id_document_country	string	Country of ID in alpha 3 code (ISO-3166)
accomodation_proof	object	Must be a valid file (application/pdf) max 4MB
zip_code	string	Zip Code (optional)
address	string	Full postal address
city	string	City of residence
document	object	must be a valid file (image/jpg, image/jpeg, image/png, application/pdf) max 4MB
document_type	string	Type of document BANK_STATEMENT ELECTRICITY_BILL INTERNET_BILL LANDLINE_BILL WATER_BILL GAS_BILL
country	string	Country of document in alpha 3 code (ISO-3166) (e.g. for France send FRA as country value

200

POST https://individual-api.synaps.io/v3/residency/submit

Request Body

Name	Type	Description
document	object	must be a valid file (image/jpg, image/jpeg, image/png, application/pdf) max 4MB

200

Get proof of residency verification details

GET https://individual-api.synaps.io/v3/residency/details

All information about proof of residency verification details

Query Parameters

Name	Type	Description
step_id	string	step_id of the phone verification step

Headers

Name	Type	Description
Session-Id	string	Synaps Session-Id
Api-Key	string	Synaps Api-Key
Client-Id	string	Synaps Client-Id

200

{
    "document": {
        "document": {
            "type": "ELECTRICITY_BILL",
            "filetype": "application/pdf",
            "file": "<signed_url>"
        },
        "is_accomodation": false,
        "state": "VALIDATED",
        "lang": "en",
        "info": {
            "firstname": "JOHN",
            "lastname": "DOE",
            "address": "221B Baker Street",
            "country": "GBR",
            "city": "Greater London",
            "zipcode": "239X8A",
            "issuing_date": "2021-07-06"
        },
    },
    "history": [
        {
            "user_reason": "",
            "customer_reason": "",
            "rejection_code": "",
            "submitted_at": "2021-07-27 13:31:47",
            "verified_at": "2021-07-27 13:58:08",
            "state": "VALIDATED"
        }
    ],
    "state": "VALIDATED"
}

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 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 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