Submit document

To submit a proof of residency for verification, you can use our iframe integration to integrate in a few seconds a full interface directly on your web or mobile app. Otherwise, you can use directly our API to send us document to review.

post
Submit residency request

https://residency-api.synaps.io/v2/residency/submit
Send a proof of residency to verification
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
country
required
string
Country of document in alpha 3 code (ISO-3166) (e.g. for France send FRA as country value)
Response
200: OK
Success
{
"session_id": "ca9fc5fd-421d-6990-6f84-15c3b67b"
}
400: Bad Request
Invalid Country
{
"api_code": "RESIDENCY_COUNTRY_INVALID",
"message": "Residency country invalid"
}

API Response

Field

Type

Description

session_id

string

Session-Id of the submitted residency

auto_residency

string

AVAILABLE if auto residency is enabled (next step: call Submit Auto Residency Request)

NOT_AVAILABLE if auto residency is not enabled

post
Submit auto residency request

https://residency-api.synaps.io/v2/residency/verify/auto
Send proof of residency details of the user to check if it matches with our internal proof of address database
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
firstname
required
string
Firstname of the person
lastname
required
string
Lastname of the person
address
required
string
Postal address of the person
city
required
string
City of the address
Response
200: OK

API Response

Field

Type

Description

session_id

string

Session-Id of the submitted residency

auto_residency

string

FOUND - Records has been found for this user and the associated address

NOT_AVAILABLE - No record has been found, user have to upload his proof of residency document

post
Upload proof of residency document

https://residency-api.synaps.io/v2/residency/verify/manual
Send a proof of residency document to verification
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
document
required
object
must be a valid file (image/jpg, image/jpeg, image/png, application/pdf) max 4MB
document_type
required
string
Type of document UTILITY_BILL BANK_STATEMENT
Response
200: OK