Smart Carrier | API | STI - Certificate Manager - Post a Certificate

Smart Carrier | API | STI - Certificate Manager - Post a Certificate

Certificate Manager - Post a Certificate

The Certificate Manager API is a RESTful-compliant which may be accessed via HTTPS using an API Key. You may obtain your API Key from your web portal or from your NumberRisk sales representative. All results are returned as JSON. Charges apply to use this API.

Below, please find the endpoints and examples:

  • Endpoint:

    •  https://api.smartcarrier.io/v2/certificate-manager

  • Method:

    • POST

  • Body Type:

    • multipart/form-data (refer to the code example below for more information).

  • Parameters:

    • friendly_name: The name for this certificate.

      • Example: My Certificate - 338J

    • certificate: The certificate file. Please refer to the code example below for more information.

    • private_key: The private key which corresponds to this certificate.

  • Headers:

    • x-api-key: Your API key.


  • Return: If the certificate package is successfully processed, you will receive a certificate ID, which may be used to uniquely identify this certificate and request tokens using this pair:

    • Successful: 

      • {
          isOk: true,
          certificate_id: <the hash which identifies the certificate>,
        }
    • Unsuccessful:

      • {
          isOk: false,
          message: <message describing the error>,
        }
Postman Example:

  1. --header 'x-api-key: XXXXX' \
    --form 'friendly_name="My Certificate"' \
    --form 'certificate=@"/path/to/file"' \
    --form 'private_key=@"/path/to/file"'