Retrieve Certificate by IAF ID

Retrieve Certificate by IAF ID

Get certificate details by IAF ID.

GET /certificate/{cert_id}

Fields that are marked with an asterisk (*) are mandatory.

• Certificate Information Requirements:

  • The API requires the cert_id of a Certificate.

• Response value:

  • The API will return a single matched Certificate record.

Headers

Name	Type	Description
Content-Type*	String	application/json
x-http-authorization*	String	API Key received from https://www.iafcertsearch.org/api-verification Example: x-http-authorization: <<API KEY>>

Parameters

Key	Type	Description
cert_id*	String	The ID of the Certificate. Example: cert_GuFIQmBnjaNG8Xvz7Q3DeBVx

Requests

cURL

curl --location --globoff --request GET '{API-URL}/certificate/{cert_id}' \
--header 'x-http-authorization: <API_KEY>' \
--header 'Content-Type: application/json'

Ruby

require "uri"
require "json"
require "net/http"

url = URI("{API_URL}/certificate/{cert_id}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["x-http-authorization"] = "<API_KEY>"
request["Content-Type"] = "application/json"

response = http.request(request)
puts response.read_body

Python

import http.client
import json

conn = http.client.HTTPConnection("{API_URL}")
payload = ''
headers = {
  'x-http-authorization': '<API_KEY>',
  'Content-Type': 'application/json'
}
conn.request("GET", "/certificate/{cert_id}", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{API_URL}/certificate/{cert_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'x-http-authorization: <API_KEY>',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{API_URL}/certificate/{cert_id}")
  .method("GET", body)
  .addHeader("x-http-authorization", "<API_KEY>")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Node.js

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{API_URL}/certificate/{cert_id}',
  headers: { 
    'x-http-authorization': '<API_KEY>', 
    'Content-Type': 'application/json'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Go

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{API_URL}/certificate/{cert_id}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("x-http-authorization", "<API_KEY>")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

C#

var options = new RestClientOptions("{API_URL}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/certificate/{cert_id}", Method.Get);
request.AddHeader("x-http-authorization", "<API_KEY>");
request.AddHeader("Content-Type", "application/json");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Responses

200

Request Successful

{
  "data": {
    "cert_id": string,
    "accreditation_bodies_name": string,
    "certification_bodies_name": string,
    "certification_number": string,
    "certification_status": string,
    "certification_scope": string,
    "certification_standards_scheme": [
      {
        "standard_name": string,
        "scheme_name": string,
        "is_accredited_mla": boolean
      }
    ],
    "certification_main_sites": [
      {
        "street": string,
        "city": string,
        "state": string,
        "post_code": string,
        "full_address": string,
        "scope": string, 
        "country": string
      }
    ],
    "certification_additional_sites": [
      {
        "street": string,
        "city": string,
        "state": string,
        "post_code": string,
        "full_address": string,
        "scope": string,
        "country": string
      }
    ],
    "certification_sectors": [
      {
        "sector_name": string,
        "sector_code": string
      }
    ],
    "certified_entities": [
      {
        "ce_id": string,
        "certified_entity_name": string,
        "certified_entity_english_name": string,
        "certified_entity_trading_name": string,
        "country": string,
        "certified_entity_addresses": [
          {
            "street": string,
            "city": string,
            "state": string,
            "post_code": string,
            "full_address": string,
            "country": string
          }
        ],
      }
    ],
    "updated_at": integer
  }
}

200

Some data are Confidential

{
  "data": {
    "cert_id": string,
    "accreditation_bodies_name": string,
    "certification_bodies_name": string,
    "certification_number": "Confidential",
    "certification_status": string,
    "certification_scope": string,
    "certification_standards_scheme": "Confidential",
    "certification_main_sites": [
      {
        "street": string,
        "city": string,
        "state": string,
        "post_code": string,
        "full_address": string,
        "scope": string,
        "country": string
      }
    ],
    "certification_additional_sites": [
      {
        "street": string,
        "city": string,
        "state": string,
        "post_code": string,
        "full_address": string,
        "scope": string,
        "country": string
      }
    ],
    "certification_sectors": [
      {
        "sector_name": string,
        "sector_code": string
      }
    ],
    "certified_entities": [
      {
        "ce_id": string,
        "certified_entity_name": string,
        "certified_entity_english_name": "Confidential",
        "certified_entity_trading_name": "Confidential",
        "country": string,
        "certified_entity_addresses": [
          {
            "street": "Confidential",
            "city": "Confidential",
            "state": "Confidential",
            "post_code": "Confidential",
            "full_address": "Confidential",
            "country": string
          }
        ],
      }
    ],
    "updated_at": integer
  }
}

200

All data are Confidential

{
    "data": "Confidential"
}

401

Unauthorized Access

{
  "type": "string",
  "title": "Unauthorized access.",
  "status": 401,
  "detail": "Authentication failed due to invalid credentials or missing token.",
  "instance": "/certificate/{cert_id}",
  "code": "unauthorized"
}

403

Forbidden Access

{
  "type": "string",
  "title": "Forbidden access.",
  "status": 403,
  "detail": "You do not have access to this resource.",
  "instance": "/certificate/{cert_id}",
  "code": "forbidden"
}

403

Insufficient Credit

{
  "type": "string",
  "title": "Insufficient credit.",
  "status": 403,
  "detail": "You are trying to access data that exceeds your available credits. To increase your available credits, please contact us at [email protected].",
  "instance": "/certificate/{cert_id}",
  "code": "insufficient_credit"
}

403

API Request Limit Reached

{
    "type": "string",
    "title": "API request limit reached.",
    "status": 403,
    "detail": "API request limit reached. To increase your API request limit, contact us at [email protected].",
    "instance": "/certificate/{cert_id}",
    "code": "api_request_limit_reached"
}

404

Not Found

{
  "type": "string",
  "title": "Resource not found.",
  "status": 404,
  "detail": "Certification not found in IAFCertSearch.",
  "instance": "/certificate/{cert_id}",
  "code": "not_found"
}