Update Certified Entity Details

This endpoint allows you to update Certified Entity details specified with its GUID.

PUT https://api.iafcertsearch.org/api/client/v1/cb/ce-by-guid

The company_guid field is always required. Other fields that are marked with an asterisk (*) are mandatory if present in the request body.

Headers

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

Request Body

Name	Type	Description
company_guid*	String	A unique identifier for a specific Certified Entity. Used as a reference or a tracking number to look up Certified Entity records in the IAF CertSearch database.
company_trading_name	String	Company Trading Name Example: Test Food and Logistics Inc. Trading Name Reliable Logistics Services Inc. Trading Name
company_en_name	String	Company English Name Example: Test Food and Logistics Inc. English Name Reliable Logistics Services Inc. English Name
company_country*	String	Country/Economy of the main entity address for the certified entity.
company_street	String	Company Street
company_city	String	Company City
company_state	String	Company State
company_postcode	String	Company Post Code
company_website	String	Company Website
system_information	String	System Information Information of a specific Certified Entity used by the IAF CertSearch database. Example: "system_information" : { "company_name" : "string", "company_guids" : [ "string", "string" ] }, or "system_information": [ { "company_name": "string", "company_guid": "string" } ]
company_id_number	String	Company Identification Number Example: U12345ABCDE12345F123456
business_registration_number	String	Business Registration Number Example: 1234567890A
tax_id	String	Tax Identification Example: 000123456001

200: OK Request successful.

{
    "data": {
        "company_id": "string",
        "company_name": "string",
        "company_trading_name": "string",
        "company_street": "string",
        "company_city": "string",
        "company_suburb": "string",
        "company_postcode": "string",
        "company_state": "string",
        "company_country": "string",
        "company_email": "string",
        "company_status": "string",
        "company_type": "string",
        "company_contact": "string",
        "company_logo": "[]",
        "company_banner": "[]",
        "countries_id": number,
        "company_website": "string",
        "company_tz": number,
        "company_tz_text": "string",
        "company_hash": "string",
        "company_guid": "string",
        "company_phone": "string",
        "company_business_type": "string",
        "company_address": "string",
        "company_en_name": "string",
        "tax_id": "string",
        "business_reg_number": "string",
        "company_id_number": "string",
        "qualitytrade_id": number,
        "qualitytrade_hash": "string"    ,
        "company_search_limit": number,
        "is_confidential": number,
        "activated_at": date,
        "created_at": date,
        "updated_at": date
    }
}

400: Bad Request Other errors that is described in the API response.

{
    "error": true,
    "timestamp": number (Epoch time),
    "elapse": number,
    "errors": {
      "message": "error_message",
      "code": "error_code"
    }
}

401: Unauthorized Happens when you use invalid API key.

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

422: Unprocessable Entity Did not pass parameter validation

{
    "error": true,
    "timestamp": number (Epoch time),
    "elapse": number,
    "errors": {
        "code": "validation_error",
        "message": {
            "field_name": "error_message"
        }
    }
}

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/ce-by-guid to test it on the Sandbox server.

Take a look at how you might call this method:

cURL

curl --location --request PUT 'https://api.iafcertsearch.org/api/client/v1/cb/ce-by-guid' \
--header 'x-http-authorization: <<API_KEY>>' \
--header 'Content-Type: application/json' \
--header 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36' \
--data-raw '{
    "company_guid" : "string",
    "company_trading_name": "string",
    "company_en_name": "string",
    "company_country": "string",
    "company_street": "string",
    "company_city": "string",
    "company_state": "string",
    "company_postcode": "string",
    "company_website": "string",
    "tax_id": "string",
    "business_registration_number":: "string",
    "company_id_number": "string",
    "system_information":{
        "company_name": "string",
        "company_guids": [
            "string",
            "string"
        ]
    }
}'

Ruby

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

url = URI("https://api.iafcertsearch.org/api/client/v1/cb/ce-by-guid")

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

request = Net::HTTP::Put.new(url)
request["x-http-authorization"] = "<<API_KEY>>"
request["Content-Type"] = "application/json"
request["User-Agent"] = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36"
request.body = JSON.dump({
  "company_guid": "string",
  "company_trading_name": "string",
  "company_en_name": "string",
  "company_country": "string",
  "company_street": "string",
  "company_city": "string",
  "company_state": "string",
  "company_postcode": "string",
  "company_website": "string",
  "tax_id": "string",
  "business_registration_number":: "string",
  "company_id_number": "string",
  "system_information": {
    "company_name": "string",
    "company_guids": [
      "string",
      "string"
    ]
  }
})

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

Python

import http.client
import json

conn = http.client.HTTPSConnection("api.iafcertsearch.org")
payload = json.dumps({
  "company_guid": "string",
  "company_trading_name": "string",
  "company_en_name": "string",
  "company_country": "string",
  "company_street": "string",
  "company_city": "string",
  "company_state": "string",
  "company_postcode": "string",
  "company_website": "string",
  "tax_id": "string",
  "business_registration_number":: "string",
  "company_id_number": "string",
  "system_information": {
    "company_name": "string",
    "company_guids": [
      "string",
      "string"
    ]
  }
})
headers = {
  'x-http-authorization': '<<API_KEY>>',
  'Content-Type': 'application/json',
  'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36'
}
conn.request("PUT", "/api/client/v1/cb/ce-by-guid", 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/ce-by-guid',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "company_guid" : "string",
    "company_trading_name": "string",
    "company_en_name": "string",
    "company_country": "string",
    "company_street": "string",
    "company_city": "string",
    "company_state": "string",
    "company_postcode": "string",
    "company_website": "string",
    "tax_id": "string",
    "business_registration_number":: "string",
    "company_id_number": "string",
    "system_information":{
        "company_name": "string",
        "company_guids": [
            "string",
            "string"
        ]
    }
}',
  CURLOPT_HTTPHEADER => array(
    'x-http-authorization: <<API_KEY>>',
    'Content-Type: application/json',
    'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36'
  ),
));

$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, "{\r\n    \"company_guid\" : \"string\",\r\n    \"company_trading_name\": \"string\",\r\n    \"company_en_name\": \"string\",\r\n    \"company_country\": \"string\",\r\n    \"company_street\": \"string\",\r\n    \"company_city\": \"string\",\r\n    \"company_state\": \"string\",\r\n    \"company_postcode\": \"string\",\r\n    \"company_website\": \"string\",\r\n        \"tax_id\": \"string\",\r\n        \"business_registration_number\": \"string\",\r\n        \"company_id_number\": \"string\",\r\n        \"system_information\":{\r\n        \"company_name\": \"string\",\r\n        \"company_guids\": [\r\n            \"string\",\r\n            \"string\"\r\n        ]\r\n    }\r\n}");
Request request = new Request.Builder()
  .url("https://api.iafcertsearch.org/api/client/v1/cb/ce-by-guid")
  .method("PUT", body)
  .addHeader("x-http-authorization", "<<API_KEY>>")
  .addHeader("Content-Type", "application/json")
  .addHeader("User-Agent", "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36")
  .build();
Response response = client.newCall(request).execute();

Node

var axios = require('axios');
var data = JSON.stringify({
  "company_guid": "string",
  "company_trading_name": "string",
  "company_en_name": "string",
  "company_country": "string",
  "company_street": "string",
  "company_city": "string",
  "company_state": "string",
  "company_postcode": "string",
  "company_website": "string",
  "tax_id": "string",
  "business_registration_number":: "string",
  "company_id_number": "string",
  "system_information": {
    "company_name": "string",
    "company_guids": [
      "string",
      "string"
    ]
  }
});

var config = {
  method: 'put',
  url: 'https://api.iafcertsearch.org/api/client/v1/cb/ce-by-guid',
  headers: { 
    'x-http-authorization': '<<API_KEY>>', 
    'Content-Type': 'application/json', 
    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36'
  },
  data : data
};

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

Go

package main

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

func main() {

  url := "https://api.iafcertsearch.org/api/client/v1/cb/ce-by-guid"
  method := "PUT"

  payload := strings.NewReader(`{`+"
"+`
    "company_guid" : "string",`+"
"+`
    "company_trading_name": "string",`+"
"+`
    "company_en_name": "string",`+"
"+`
    "company_country": "string",`+"
"+`
    "company_street": "string",`+"
"+`
    "company_city": "string",`+"
"+`
    "company_state": "string",`+"
"+`
    "company_postcode": "string",`+"
"+`
    "company_website": "string",`+"
"+`
    "tax_id": "string",`+
"+`
    "business_registration_number": "string",`+
"+`
    "company_id_number": "string",`+
"+`
        "system_information":{`+"
"+`
        "company_name": "string",`+"
"+`
        "company_guids": [`+"
"+`
            "string",`+"
"+`
            "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")
  req.Header.Add("User-Agent", "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36")

  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/ce-by-guid");
client.Timeout = -1;
var request = new RestRequest(Method.PUT);
request.AddHeader("x-http-authorization", "<<API_KEY>>");
request.AddHeader("Content-Type", "application/json");
client.UserAgent = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36";
var body = @"{
" + "\n" +
@"    ""company_guid"" : ""string"",
" + "\n" +
@"    ""company_trading_name"": ""string"",
" + "\n" +
@"    ""company_en_name"": ""string"",
" + "\n" +
@"    ""company_country"": ""string"",
" + "\n" +
@"    ""company_street"": ""string"",
" + "\n" +
@"    ""company_city"": ""string"",
" + "\n" +
@"    ""company_state"": ""string"",
" + "\n" +
@"    ""company_postcode"": ""string"",
" + "\n" +
@"    ""company_website"": ""string"",
" + "\n" +
@"    ""tax_id"": ""string"",
" + "\n" +
@"    ""business_registration_number"": ""string"",
" + "\n" +
@"    ""company_id_number"": ""string"",
" + "\n" +
@"        ""system_information"":{
" + "\n" +
@"        ""company_name"": ""string"",
" + "\n" +
@"        ""company_guids"": [
" + "\n" +
@"            ""string"",
" + "\n" +
@"            ""string""
" + "\n" +
@"        ]
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);