Certificates

Certificates can be generated on-demand via the Synaps Connect API to have a proof of verification for both identity and residency scopes.

Every certificate comes with user data and the submitted document. Certificates are generated only for your app and they are watermarked with the name of your app.

Certificates can only be generated if you have chosen data mode for identity or residency scope.

Certificate Workflow

The flow to generate a certificate is:

  1. Request a certificate to receive a Download Code and a Certificate Unique Identifier (CUID)

  2. Get notified when a certificate is ready using a webhook

  3. Download the certificate using your Download Code and CUID

post
Request individual user certificate

https://connect.synaps.io/v1/resources/certificates/{type}/individual
Make sure to store your download code and CUID because they will be required when you will download certificate. Return a CUID and a download code for a single user certificate
Request
Response
Path Parameters
type
required
string
Certificate type identity - Identity certificate residency - Residency certificate
Headers
Authorization
required
string
Your app client_id and client_secret separated by colon Example S1119345501234566:PD2rzu3QYUkenwEf8ua6w7ENCrBs
Content-Type
optional
string
application/json
Query Parameters
uuid
required
string
User Unique Identifier (UUID) Example : 17673298664955093
200: OK
Certificate response
{
"data": {
"cuid": "C828251141729142",
"download_code": "hwfSWpF44EjwpEvZXs6GAKua5a06fXi7"
},
"status": {
"error": false,
"api_code": "SUCCESS",
"type": "success",
"message": "success"
}
}
400: Bad Request
Invalid UUID
{
"data": null,
"status": {
"error": true,
"api_code": "APPS_INVALID_UUID",
"type": "error",
"message": "Invalid UUID"
}
}

Certificates can only be generated for verified users

API Response

Field

Type

Description

cuid

string

Certificate Unique Identifier (CUID)

download_code

string

Download code

post
Request corporate user certificate

https://connect.synaps.io/v1/resources/certificates/corporate
Make sure to store your download code and CUID because they will be required when you will download certificate. Return a CUID and a download code for a single user certificate
Request
Response
Headers
Authorization
required
string
Your app client_id and client_secret separated by colon Example S1119345501234566:PD2rzu3QYUkenwEf8ua6w7ENCrBs
Content-Type
optional
string
application/json
Query Parameters
uuid
required
string
User Unique Identifier (UUID) of the person who authorized the corporate Example : 17673298664955093
200: OK
Certificate response
{
"data": {
"cuid": "C828251141729142",
"download_code": "hwfSWpF44EjwpEvZXs6GAKua5a06fXi7"
},
"status": {
"error": false,
"api_code": "SUCCESS",
"type": "success",
"message": "success"
}
}
400: Bad Request
Invalid UUID
{
"data": null,
"status": {
"error": true,
"api_code": "APPS_INVALID_UUID",
"type": "error",
"message": "Invalid UUID"
}
}

Certificates can only be generated for verified corporate

API Response

Field

Type

Description

cuid

string

Certificate Unique Identifier (CUID)

download_code

string

Download code

get
State certificate

https://connect.synaps.io/v1/resources/certificates/state
Return state information about a certificate
Request
Response
Headers
Authorization
required
string
Your app client_id and client_secret separated by colon Example S1119345501234566:PD2rzu3QYUkenwEf8ua6w7ENCrBs
Content-Type
optional
string
application/json
Query Parameters
cuid
required
string
Certificate Unique Identifier (CUID) Example : C1119345501234566
200: OK
Certificate state
{
"data": {
"state": "READY",
"size": 3.79
},
"status": {
"error": false,
"api_code": "SUCCESS",
"type": "success",
"message": "success"
}
}

API Response

Field

Type

Description

state

string

State of certificate

‚Äč

READY - Certificate is ready to download

PENDING - Certificate is pending completion

EXPIRED - Certificate is expired

size

number

Size of certificate (in mb) when READY to download

expires_at

number

expiration date in timestamp

get
Download certificate

https://connect.synaps.io/v1/resources/certificates/download
Return requested ZIP file folder
Request
Response
Headers
Authorization
required
string
Your app client_id and client_secret separated by colon Example S1119345501234566:PD2rzu3QYUkenwEf8ua6w7ENCrBs
Query Parameters
cuid
required
string
Certificate Unique Identifier (CUID) Example : C1119345501234566
download_code
required
string
Certificate download code Example : pzeDSvy4Wwl2GYJbDCIiBSlq
200: OK
oct
{
"data": {
"download_link": "https://synaps-certificates-residency-storage.s3.eu-west-3.amazonaws.com/CUID.zip"
},
"status": {
"error": false,
"api_code": "SUCCESS",
"type": "success",
"message": "success"
}
}

Download link lasts 24 hours

API Response

Field

Type

Description

download_link

string

AWS S3 Signed download link

The download link will gives you a ZIP file of all requested certificates. This folder contains all PDF certificates requested named as follow : UUID-CUID.pdf .