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

https://residency-api.synaps.io/v2/residency/submit
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
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 identity