Bulk Retrieve Company & Certificates by IAF ID

Bulk Retrieve Company & Certificates by IAF ID

Get multiple companies and certificates by IAF IDs.

POST /bulk-company-by-id

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

• The API can match multiple Certified Entities from IAFCertSearch per request.

• Certified Entity Requirements:

  • ce_ids must be provided.

  • The maximum number of ce_ids that this endpoint accepts is 1000.

• Response Value:

  • The API will return a list of matched Certified Entities with its Certificates.

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>>

Request Body

Name	Type	Description
ce_ids	Array of strings	ID of the companies or Certified Entities. Example: { "ce_ids": [ "ce_O8fEcGngmWwaU9OOKxGlR2gV" ] } The maximum number of IDs that this endpoint accepts is 1000.

Example Payload Request

Certified Entity Ids

{
  "ce_ids": [
    "string",
    "string",
    "string"
  ]
}

Requests

cURL

curl --location --request POST '{API_URL}/bulk-company-by-id' \
--header 'x-http-authorization: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "ce_ids": [
        "string"
    ]
}'

Ruby

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

url = URI("{API_URL}/bulk-company-by-id")

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

request = Net::HTTP::Post.new(url)
request["x-http-authorization"] = "<API_KEY>"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "ce_ids": [
    "string"
  ]
})

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

Python

import http.client
import json

conn = http.client.HTTPSConnection("{API_URL}")
payload = json.dumps({
  "ce_ids": [
    "ce_O8fEcGngmWwaU9OOKxGlR2gV"
  ]
})
headers = {
  'x-http-authorization': '{{API_KEY}}',
  'Content-Type': 'application/json'
}
conn.request("POST", "/bulk-company-by-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}/bulk-company-by-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 => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "ce_ids": [
        "string"
    ]
}',
  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, "{\n    \"ce_ids\": [\n        \"string\"\n    ]\n}");
Request request = new Request.Builder()
  .url("{API_URL}/bulk-company-by-id")
  .method("POST", 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 data = JSON.stringify({
  "ce_ids": [
    "string"
  ]
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{API_URL}/bulk-company-by-id',
  headers: { 
    'x-http-authorization': '{API_KEY}', 
    'Content-Type': 'application/json'
  },
  data : data
};

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

Go

package main

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

func main() {

  url := "{API_URL}/bulk-company-by-id"
  method := "POST"

  payload := strings.NewReader(`{
    "ce_ids": [
        "string"
    ]
}`)

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

  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}/bulk-company-by-id")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("x-http-authorization", "{API_KEY}");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@"    ""ce_ids"": [" + "\n" +
@"        ""string""" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Responses

200

Request Successful

{
    "data": [
        {
            "ce_id": string,
            "matched_certified_entity_name": string,
            "match_status": string,
            "match_type": 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
              }
            ],
            "certificates": [
                {
                    "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
                        }
                    ],
                    "updated_at": integer
                }
            ]
        }
    ]
}

200

Some data are Confidential

{
    "data": [
        {
            "ce_id": string,
            "matched_certified_entity_name": string,
            "match_status": string,
            "match_type": 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
              }
            ],
            "certificates": [
                {
                    "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
                        }
                    ],
                    "updated_at": integer
                }
            ]
        }
    ]
}

200

No Results

{
  "data": []
}

401

Unauthorized Access

{
  "type": "string",
  "title": "Unauthorized access.",
  "status": 401,
  "detail": "Authentication failed due to invalid credentials or missing token.",
  "instance": "/bulk-company-by-id",
  "code": "unauthorized"
}

403

Forbidden Access

{
  "type": "string",
  "title": "Forbidden access.",
  "status": 403,
  "detail": "You do not have access to this resource.",
  "instance": "/bulk-company-by-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": "/bulk-company-by-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": "/bulk-company-by-id",
    "code": "api_request_limit_reached"
}