Certificate

Check certificate ownership

get

Path parameters

nfc_idstringRequired

Query parameters

user_idstringRequired

Responses

200Success

application/json

get

/certificate/checkOwnership/{nfc_id}

HTTPcURLJavaScriptPython

GET /certificate/checkOwnership/{nfc_id}?user_id=text HTTP/1.1
Host: 
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Claim certificate ownership

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

nfc_idstringRequired

Body

application/json

proof_of_purchase_codestringOptional

persona_idstringOptional

Responses

200Success

application/json

post

/certificate/claim/{nfc_id}

HTTPcURLJavaScriptPython

POST /certificate/claim/{nfc_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "proof_of_purchase_code": "text",
  "persona_id": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Get user certificates

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

persona_idstringRequired

include_legacystringRequired

Responses

200Success

application/json

get

/certificate/all

HTTPcURLJavaScriptPython

GET /certificate/all?persona_id=text&include_legacy=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Get one certificate for a user

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

certificate_idstringRequired

Responses

200Success

application/json

get

/certificate/{certificate_id}

HTTPcURLJavaScriptPython

GET /certificate/{certificate_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Get one voucher for a user

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

certificate_idstringRequired

coupon_idstringRequired

Responses

200Success

application/json

get

/certificate/coupon/{certificate_id}/{coupon_id}

HTTPcURLJavaScriptPython

GET /certificate/coupon/{certificate_id}/{coupon_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Send ephemeral link for a certificate to a user

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

certificate_idstringRequired

Body

application/json

emailstringOptional

Responses

200Success

application/json

post

/certificate/send/link/{certificate_id}

HTTPcURLJavaScriptPython

POST /certificate/send/link/{certificate_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "email": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Init a transfer for a certificate

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

certificate_idstringRequired

Body

application/json

phone_numberstringOptional

Responses

200Success

application/json

post

/certificate/transfer/{certificate_id}

HTTPcURLJavaScriptPython

POST /certificate/transfer/{certificate_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "phone_number": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Claim a certificate from a transfer

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

fromstringRequired

Responses

200Success

application/json

post

/certificate/transfer/claim/{from}

HTTPcURLJavaScriptPython

POST /certificate/transfer/claim/{from} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Cancel a transfer

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

transfer_idstringRequired

Responses

200Success

application/json

delete

/certificate/transfer/cancel/{transfer_id}

HTTPcURLJavaScriptPython

DELETE /certificate/transfer/cancel/{transfer_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}

Get transferred certificate informations

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

fromstringRequired

Body

application/json

objectobjectRequired

subjectobjectRequired

Responses

200Success

application/json

get

/certificate/transfer/claim/information/{from}

HTTPcURLJavaScriptPython

GET /certificate/transfer/claim/information/{from} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "object": {},
  "subject": {}
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "CheckOwnershipData | CertificateData | ..."
}