Retrieve all Certifications

Retrieve all Certifications

GET https://api.iafcertsearch.org/api/client/v1/cb/cert

This endpoint retrieves the data of all registered certifications.

Headers

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

Request Body

Name	Type	Description
limit	String	Limit
offset	String	Offset

200: OK Request successful.

{
  "data": [
    {
      "company_certifications_id": string,
      "company_id": string,
      "scope_description": string,
      "issue_date": string,
      "expiry_date": string,
      "original_issue_date": string,
      "status": string,
      "type": string,
      "model_number": string,
      "certification_number": string,
      "certification_bodies_id": string,
      "accreditation_bodies_id": string,
      "standards_id": string,
      "accreditation_status": string,
      "scheme_id": string,
      "created_at": number,
      "updated_at": number,
      "company_name": string,
      "certification_bodies_name": string,
      "accreditation_bodies_name": string,
      "certification_bodies_accreditation_status": string,
      "withdrawn_at": number,
      "scheme_name": string,
      "standards": [
        {
          "is_accredited_mla": number,
          "standards_id": string,
          "standards_name": string,
          "standards_document_type": string,
          "scheme_name": string
        }
      ]
    },
    {
      "company_certifications_id": string,
      "company_id": string,
      "scope_description": string,
      "issue_date": string,
      "expiry_date": string,
      "original_issue_date": string,
      "status": string,
      "type": string,
      "model_number": string,
      "certification_number": string,
      "certification_bodies_id": string,
      "accreditation_bodies_id": string,
      "standards_id": string,
      "accreditation_status": string,
      "scheme_id": string,
      "created_at": number,
      "updated_at": number,
      "company_name": string,
      "certification_bodies_name": string,
      "accreditation_bodies_name": string,
      "certification_bodies_accreditation_status": string,
      "withdrawn_at": number,
      "scheme_name": string,
      "standards": [
        {
          "is_accredited_mla": number,
          "standards_id": string,
          "standards_name": string,
          "standards_document_type": string,
          "scheme_name": string
        }
      ]
    }
  ],
  "meta": {
    "total_pages": number,
    "total_rows": number,
    "order": string,
    "order_by": string,
    "limit": number,
    "offset": number,
    "next_key": string
  }
}

401: Unauthorized Happens when you use an invalid API Key.

{
    "error": true,
    "timestamp": number (Epoch time),
    "elapse": number,
    "errors": {
      "message": "Invalid Session token has been used.",
      "code": "invalid_session_token"
    }
}

To view the response data example, click the right arrow at the right side of the response description.

You can also use https://api.sandbox.iafcertsearch.org/api/client/v1/cb/cert to test it on the Sandbox server.

Take a look at how you might call this method:

cURL

curl --location --request GET 'https://api.iafcertsearch.org/api/client/v1/cb/cert' \
--header 'Content-Type: application/json' \
--header 'x-http-authorization: <<API_KEY>>'

Ruby

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

url = URI("https://api.iafcertsearch.org/api/client/v1/cb/cert")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

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

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

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.iafcertsearch.org")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'x-http-authorization': '<<API_KEY>>'
}
conn.request("GET", "/api/client/v1/cb/cert", 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 => 'https://api.iafcertsearch.org/api/client/v1/cb/cert',
  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(
    'Content-Type: application/json',
    'x-http-authorization: <<API_KEY>>'
  ),
));

$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("https://api.iafcertsearch.org/api/client/v1/cb/cert")
  .method("GET", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("x-http-authorization", "<<API_KEY>>")
  .build();
Response response = client.newCall(request).execute();

Node.js

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.iafcertsearch.org/api/client/v1/cb/cert',
  headers: { 
    'Content-Type': 'application/json', 
    'x-http-authorization': '<<API_KEY>>'
  }
};

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

Go

package main

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

func main() {

  url := "https://api.iafcertsearch.org/api/client/v1/cb/cert"
  method := "GET"

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

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

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

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

C#

var client = new RestClient("https://api.iafcertsearch.org/api/client/v1/cb/cert");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("x-http-authorization", "<<API_KEY>>");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);