Get a single certificate

Description

Displays a single certificate from provided certificate_id.

GET https://impact.dots.eco/api/v1/certificate/{certificate_id}

Parameters

certificate_id - required^*,integer ID of the certificate you want to display. It can be obtained from the certificate list response and from the certificate request response.

Example request

The minimal request that will work

curl --location --request GET 'https://impact.dots.eco/api/v1/certificate/1' \
--header 'Content-Type: application/json' \
--header 'auth-token: YOUR_AUTH_TOKEN' \
--data-raw '{
}'

Key/Value pairs response body

"certificate_id": [string] - ID of the certificate.
"external_unique_id": [string] - External ID of that certificate
"certificate_url": [string] - Certificate Url
"certificate_image_url": [string] - Certificate Image Url
"app_id": [integer] - Application ID
"app_name": [string] - Name of Application
"remote_user_id": [string] - Remote User ID
"name_on_certificate": [string] - The Username printed on Certificate.
"certificate_design": [string] - The Certificate Design.
"certificate_info": [string] - The Certificate Info.
"impact_qty": [integer] - Impact Quantity
"impact_type_id": [integer] - Impact Type ID
"impact_type_name": [string] - Name of the Impact Type
"impact_status": [string] - Status of Impact
"created_timestamp": [string] - Created Date Timestamp
"allocation_id": [integer] - Allocation ID
"send_certificate_by_email": [string] - Send Certificate by email
"langcode": [string] - Returns the response in the provided language code. List of supported languages can be found here.
"country": [string] - Certificate Country
"geolocation": [object] - Certificate geolocation, can be a polygon represented by multiple points.

Example response

success

{
    "certificate_id": "134411-6-5",
    "certificate_url": "https://impact.dots.eco/certificate/1ca15b15-dec1-494b-884f-a9fefa953a67",
    "certificate_image_url": "https://impact.dots.eco/certificate/img/1ca15b15-dec1-494b-884f-a9fefa953a67.jpg",
    "app_id": "6",
    "app_name": "Dots.eco",
    "remote_user_id": "testuser",
    "name_on_certificate": "John Doe",
    "certificate_design": null,
    "certificate_info": null,
    "impact_qty": "1",
    "impact_type_id": "196",
    "impact_type_name": "Save a Sea Turtle",
    "impact_status": null,
    "created_timestamp": "1663080297",
    "allocation_id": "14",
    "country": "Costa Rica",
    "geolocation": [
        {
            "lat": 10.31709345,
            "lng": -83.357477040000006
        }
    ]
}

Possible error responses

Invalid certificate

{
  "message": "Certificate with ID '$certificate_id' was not found."
}

Status:404 Not Found

{
  "message": "No certificate ID was provided."
}

Status:404 Not Found