# Upload Certification ## Upload Certification `POST` `https://api.iafcertsearch.org/api/client/v1/cb/upload-cert` Fields that are marked with an asterisk (`*`) are mandatory. #### Headers | Name | Type | Description | | ------------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Content-Type\* | String | application/json | | x-http-authorization\* | String |

API Key received from

Example:

x-http-authorization: <\>

| #### Request Body | Name | Type | Description | | -------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | certificate\_number\* | String | Certificate number shown on the certificate itself. | | certificate\_identity\_number | String |

Certificate Identity Number

A unique identifier that provides a more secure form of identification.

| | certification\_status\* | String |

Certification Status Include the terms that the Certification Body uses to define the status of the certification.

Accepted Values:

Active (valid)
Inactive
Withdrawn
Suspended
Cancelled (terminated)
Hidden (where details of a certification have been uploaded but it is not yet active/live)

Expired
CB Withdrawn
Pending
Deleted

If terms vary from the above terms the IAF CertSearch will provide a mapping process.

\*Note: Certifications uploaded via API with the hidden certification\_status displays as "Draft" when you log in to IAF CertSearch.

| | certificate\_accreditation\_status | String |

Has this certificate been issued under and existing accreditation or is this an unaccredited certificate.

Accepted values:

Accredited

Unaccredited

| | certification\_type\* | String |

Certification Type

Accepted Values:

Management System

If terms vary from the above terms the IAF CertSearch will provide a mapping process.

| | certification\_scope | String |

Certification Scope

Example:

Manufacturing, marketing and export of instruments, consumables and accessories for temperature, active oxygen, hydrogen, carbon measurements and sampling in ferrous and non-ferrous melts.

| | certification\_original\_issue\_date | String |

Original certification date (YYYYMMDD).

Example:

20170203

| | certification\_issue\_date\* | String |

Most recent certification date as detailed on the certificate (YYYYMMDD).

Example:

20170203

| | certification\_expiry\_date\* | String |

Certification expiry date as detailed on the certificate (YYYYMMDD).

Example:

20170203

| | certified\_entity\_name\* | String |

Certified Entity Name (company name) as detailed on the certificate.

Example:

Test Food and Logistics Inc.
Reliable Logistics Services Inc.

| | certified\_entity\_english\_name | String |

Certified Entity English Name

Example:

Test Food and Logistics Inc. English Name
Reliable Logistics Services Inc. English Name

| | certified\_entity\_trading\_name | String |

Certified Entity Trading Name

Example:

Test Food and Logistics Inc. Trading Name
Reliable Logistics Services Inc. Trading Name

| | certified\_entity\_unique\_id\* | String |

Mandatory Field provided by the Certification Body

"Certified Entity Unique ID" also referred to as a client ID. The "Certified Entity Unique ID" / Client ID is a unique identification number for the organisation. The entity ID makes it possible to identify which individual certifications belong to the one organisation. The "Certified Entity Identity Number" can be any alpha numeric number.

Example:

UNIQUEID-COMPANY01
UNIQUEID-COMPANY02

| | certified\_entity\_street\_address | String | The main entity address for the certified entity. | | certified\_entity\_street\_city | String | City of the main entity address for the certified entity. | | certified\_entity\_state | String | State of the main entity address for the certified entity. If no state, leave blank. | | certified\_entity\_post\_code | String | Zip code or post code of the the main entity address for the certified entity. | | certified\_entity\_country\* | String | Country/Economy of the main entity address for the certified entity. | | certified\_entity\_website | String | Certified Entity Website | | confidential\_certified\_entity | String |

Where the confidentiality of the Certified Entity is defined.

Accepted Values:

Yes

No

| | accreditation\_body\_name\* | String | Accreditation Body Name | | accreditation\_body\_acronym\_name\* | String | Accreditation Body Acronym **Certification Bodies** must apply the exact **Accreditation Body** acronym that IAF CertSearch uses for that Accreditation Body. This way we can map **Certification Body** certifications under the correct accreditation. You can view the Acronyms for all **Accreditation Bodies** within Data Management under "User guides". You can also use Data mapping if your system **Accreditation Body** acronym output is different to IAF CertSearch. | | schemes\* | Array |

Certification Schemes

Example:

{

"schemes": \[

{

"scheme\_name": "string",

"standard\_list": \[

{

"standards\_name": "string"

}

]

}

]

}

| | sites | Array |

Certification Sites

Example:

{

"sites": \[

{

"street": "string",

"city": "string",

"state": "string",

"country": "string",

"postcode": "string",

"scope\_description": "string"

}

]

}

To delete all existing sites of a certification, set the value of the sites key to an empty array like so:

{

"sites": \[]

}

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

| {% tabs %} {% tab title="200: OK Request successful." %} ```json { "data": { "company_certifications_id": string } } ``` {% endtab %} {% tab title="400: Bad Request Other errors that is described in the API response." %} ```json { "error": true, "timestamp": number (Epoch time), "elapse": number, "errors": { "message": "error_message", "code": "error_code" } } ``` {% endtab %} {% tab title="401: Unauthorized Happens when you use an invalid API Key." %} ```json { "error": true, "timestamp": number (Epoch time), "elapse": number, "errors": { "message": "Invalid Session token has been used.", "code": "invalid_session_token" } } ``` {% endtab %} {% tab title="422: Unprocessable Entity Did not pass validation." %} ```json { "error": true, "timestamp": number (Epoch time), "elapse": number, "errors": { "code": "validation_error", "message": { "field_name": "error_message" } } } ``` {% endtab %} {% endtabs %} {% hint style="warning" %} **Upload Certification** We recommend to have an interval of 1 minute in between API requests to avoid errors during certification data publication. {% endhint %} {% hint style="info" %} To view the response data example, click the right arrow at the right side of the response description. {% endhint %} {% hint style="info" %} You can also use to test it on the Sandbox server. {% endhint %} Take a look at how you might call this method: {% tabs %} {% tab title="cURL" %} ```shell curl --location --request POST 'https://api.iafcertsearch.org/api/client/v1/cb/upload-cert' \ --header 'Content-Type: application/json' \ --header 'x-http-authorization: <>' \ --data-raw '{ "certificate_number": "string", "certificate_identity_number": "string", "certification_status": "string", "certificate_accreditation_status": "string", "certification_type": "string", "certification_scope": "string", "certification_original_issue_date": "string", "certification_issue_date": "string", "certification_expiry_date": "string", "certified_entity_name": "string", "certified_entity_english_name": "string", "certified_entity_trading_name": "string", "certified_entity_unique_id": "string", "certified_entity_street_address": "string", "certified_entity_street_city": "string", "certified_entity_state": "string", "certified_entity_post_code": "string", "certified_entity_country": "string", "certified_entity_website": "string", "tax_id": "string", "business_registration_number": "string", "company_id_number": "string", "confidential_certified_entity": "string", "accreditation_body_name": "string", "accreditation_body_acronym_name": "string", "schemes": [ { "scheme_name": "string", "standard_list": [ { "standards_name": "string" } ] } ], "sites": [ { "street": "string", "city": "string", "state": "string", "country": "string", "postcode": "string", "scope_description": "string" } ] }' ``` {% endtab %} {% tab title="Ruby" %} ```ruby require "uri" require "json" require "net/http" url = URI("https://api.iafcertsearch.org/api/client/v1/cb/upload-cert") https = Net::HTTP.new(url.host, url.port) https.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/json" request["x-http-authorization"] = "<>" request.body = JSON.dump({ "certificate_number": "string", "certificate_identity_number": "string", "certification_status": "string", "certificate_accreditation_status": "string", "certification_type": "string", "certification_scope": "string", "certification_original_issue_date": "string", "certification_issue_date": "string", "certification_expiry_date": "string", "certified_entity_name": "string", "certified_entity_english_name": "string", "certified_entity_trading_name": "string", "certified_entity_unique_id": "string", "certified_entity_street_address": "string", "certified_entity_street_city": "string", "certified_entity_state": "string", "certified_entity_post_code": "string", "certified_entity_country": "string", "certified_entity_website": "string", "tax_id": "string", "business_registration_number": "string", "company_id_number": "string", "confidential_certified_entity": "string", "accreditation_body_name": "string", "accreditation_body_acronym_name": "string", "schemes": [ { "scheme_name": "string", "standard_list": [ { "standards_name": "string" } ] } ], "sites": [ { "street": "string", "city": "string", "state": "string", "country": "string", "postcode": "string", "scope_description": "string" } ] }) response = https.request(request) puts response.read_body ``` {% endtab %} {% tab title="Python" %} ```python import http.client import json conn = http.client.HTTPSConnection("api.iafcertsearch.org") payload = json.dumps({ "certificate_number": "string", "certificate_identity_number": "string", "certification_status": "string", "certificate_accreditation_status": "string", "certification_type": "string", "certification_scope": "string", "certification_original_issue_date": "string", "certification_issue_date": "string", "certification_expiry_date": "string", "certified_entity_name": "string", "certified_entity_english_name": "string", "certified_entity_trading_name": "string", "certified_entity_unique_id": "string", "certified_entity_street_address": "string", "certified_entity_street_city": "string", "certified_entity_state": "string", "certified_entity_post_code": "string", "certified_entity_country": "string", "certified_entity_website": "string", "tax_id": "string", "business_registration_number": "string", "company_id_number": "string", "confidential_certified_entity": "string", "accreditation_body_name": "string", "accreditation_body_acronym_name": "string", "schemes": [ { "scheme_name": "string", "standard_list": [ { "standards_name": "string" } ] } ], "sites": [ { "street": "string", "city": "string", "state": "string", "country": "string", "postcode": "string", "scope_description": "string" } ] }) headers = { 'Content-Type': 'application/json', 'x-http-authorization': '<>' } conn.request("POST", "/api/client/v1/cb/upload-cert", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` {% endtab %} {% tab title="PHP" %} ```php 'https://api.iafcertsearch.org/api/client/v1/cb/upload-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 => 'POST', CURLOPT_POSTFIELDS =>'{ "certificate_number": "string", "certificate_identity_number": "string", "certification_status": "string", "certificate_accreditation_status": "string", "certification_type": "string", "certification_scope": "string", "certification_original_issue_date": "string", "certification_issue_date": "string", "certification_expiry_date": "string", "certified_entity_name": "string", "certified_entity_english_name": "string", "certified_entity_trading_name": "string", "certified_entity_unique_id": "string", "certified_entity_street_address": "string", "certified_entity_street_city": "string", "certified_entity_state": "string", "certified_entity_post_code": "string", "certified_entity_country": "string", "certified_entity_website": "string", "tax_id": "string", "business_registration_number": "string", "company_id_number": "string", "confidential_certified_entity": "string", "accreditation_body_name": "string", "accreditation_body_acronym_name": "string", "schemes": [ { "scheme_name": "string", "standard_list": [ { "standards_name": "string" } ] } ], "sites": [ { "street": "string", "city": "string", "state": "string", "country": "string", "postcode": "string", "scope_description": "string" } ] }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'x-http-authorization: <>' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; ``` {% endtab %} {% tab title="Java" %} ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\r\n\t\"certificate_number\": \"string\",\r\n\t\"certificate_identity_number\": \"string\",\r\n\t\"certification_status\": \"string\",\r\n\t\"certificate_accreditation_status\": \"string\",\r\n\t\"certification_type\": \"string\",\r\n\t\"certification_scope\": \"string\",\r\n\t\"certification_original_issue_date\": \"string\",\r\n\t\"certification_issue_date\": \"string\",\r\n\t\"certification_expiry_date\": \"string\",\r\n\t\"certified_entity_name\": \"string\",\r\n\t\"certified_entity_english_name\": \"string\",\r\n\t\"certified_entity_trading_name\": \"string\",\r\n\t\"certified_entity_unique_id\": \"string\",\r\n\t\"certified_entity_street_address\": \"string\",\r\n\t\"certified_entity_street_city\": \"string\",\r\n\t\"certified_entity_state\": \"string\",\r\n\t\"certified_entity_post_code\": \"string\",\r\n\t\"certified_entity_country\": \"string\",\r\n\t\"certified_entity_website\": \"string\",\r\n\t\"tax_id\": \"string\",\r\n\t\"business_registration_number\": \"string\",\r\n\t\"company_id_number\": \"string\",\r\n\t\"confidential_certified_entity\": \"string\",\r\n\t\"accreditation_body_name\": \"string\",\r\n\t\"accreditation_body_acronym_name\": \"string\",\r\n\t\"schemes\": [\r\n\t\t{\r\n\t\t\t\"scheme_name\": \"string\",\r\n\t\t\t\"standard_list\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"standards_name\": \"string\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t],\r\n\t\"sites\": [\r\n\t\t{\r\n\t\t\t\"street\": \"string\",\r\n\t\t\t\"city\": \"string\",\r\n\t\t\t\"state\": \"string\",\r\n\t\t\t\"country\": \"string\",\r\n\t\t\t\"postcode\": \"string\",\r\n\t\t\t\"scope_description\": \"string\"\r\n\t\t}\r\n\t]\r\n}"); Request request = new Request.Builder() .url("https://api.iafcertsearch.org/api/client/v1/cb/upload-cert") .method("POST", body) .addHeader("Content-Type", "application/json") .addHeader("x-http-authorization", "<>") .build(); Response response = client.newCall(request).execute(); ``` {% endtab %} {% tab title="Node.js" %} ```javascript var axios = require('axios'); var data = JSON.stringify({ "certificate_number": "string", "certificate_identity_number": "string", "certification_status": "string", "certificate_accreditation_status": "string", "certification_type": "string", "certification_scope": "string", "certification_original_issue_date": "string", "certification_issue_date": "string", "certification_expiry_date": "string", "certified_entity_name": "string", "certified_entity_english_name": "string", "certified_entity_trading_name": "string", "certified_entity_unique_id": "string", "certified_entity_street_address": "string", "certified_entity_street_city": "string", "certified_entity_state": "string", "certified_entity_post_code": "string", "certified_entity_country": "string", "certified_entity_website": "string", "tax_id": "string", "business_registration_number": "string", "company_id_number": "string", "confidential_certified_entity": "string", "accreditation_body_name": "string", "accreditation_body_acronym_name": "string", "schemes": [ { "scheme_name": "string", "standard_list": [ { "standards_name": "string" } ] } ], "sites": [ { "street": "string", "city": "string", "state": "string", "country": "string", "postcode": "string", "scope_description": "string" } ] }); var config = { method: 'post', url: 'https://api.iafcertsearch.org/api/client/v1/cb/upload-cert', headers: { 'Content-Type': 'application/json', 'x-http-authorization': '<>' }, data : data }; axios(config) .then(function (response) { console.log(JSON.stringify(response.data)); }) .catch(function (error) { console.log(error); }); ``` {% endtab %} {% tab title="Go" %} ```go package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.iafcertsearch.org/api/client/v1/cb/upload-cert" method := "POST" payload := strings.NewReader(`{`+" "+` "certificate_number": "string",`+" "+` "certificate_identity_number": "string",`+" "+` "certification_status": "string",`+" "+` "certificate_accreditation_status": "string",`+" "+` "certification_type": "string",`+" "+` "certification_scope": "string",`+" "+` "certification_original_issue_date": "string",`+" "+` "certification_issue_date": "string",`+" "+` "certification_expiry_date": "string",`+" "+` "certified_entity_name": "string",`+" "+` "certified_entity_english_name": "string",`+" "+` "certified_entity_trading_name": "string",`+" "+` "certified_entity_unique_id": "string",`+" "+` "certified_entity_street_address": "string",`+" "+` "certified_entity_street_city": "string",`+" "+` "certified_entity_state": "string",`+" "+` "certified_entity_post_code": "string",`+" "+` "certified_entity_country": "string",`+" "+` "certified_entity_website": "string",`+" "+` "tax_id": "string",`+" "+` "business_registration_number": "string",`+" "+` "company_id_number": "string",`+" "+` "confidential_certified_entity": "string",`+" "+` "accreditation_body_name": "string",`+" "+` "accreditation_body_acronym_name": "string",`+" "+` "schemes": [`+" "+` {`+" "+` "scheme_name": "string",`+" "+` "standard_list": [`+" "+` {`+" "+` "standards_name": "string"`+" "+` }`+" "+` ]`+" "+` }`+" "+` ],`+" "+` "sites": [`+" "+` {`+" "+` "street": "string",`+" "+` "city": "string",`+" "+` "state": "string",`+" "+` "country": "string",`+" "+` "postcode": "string",`+" "+` "scope_description": "string"`+" "+` }`+" "+` ]`+" "+` }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") req.Header.Add("x-http-authorization", "<>") 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)) } ``` {% endtab %} {% tab title="C#" %} ```csharp var client = new RestClient("https://api.iafcertsearch.org/api/client/v1/cb/upload-cert"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("x-http-authorization", "<>"); var body = @"{ " + "\n" + @" ""certificate_number"": ""string"", " + "\n" + @" ""certificate_identity_number"": ""string"", " + "\n" + @" ""certification_status"": ""string"", " + "\n" + @" ""certificate_accreditation_status"": ""string"", " + "\n" + @" ""certification_type"": ""string"", " + "\n" + @" ""certification_scope"": ""string"", " + "\n" + @" ""certification_original_issue_date"": ""string"", " + "\n" + @" ""certification_issue_date"": ""string"", " + "\n" + @" ""certification_expiry_date"": ""string"", " + "\n" + @" ""certified_entity_name"": ""string"", " + "\n" + @" ""certified_entity_english_name"": ""string"", " + "\n" + @" ""certified_entity_trading_name"": ""string"", " + "\n" + @" ""certified_entity_unique_id"": ""string"", " + "\n" + @" ""certified_entity_street_address"": ""string"", " + "\n" + @" ""certified_entity_street_city"": ""string"", " + "\n" + @" ""certified_entity_state"": ""string"", " + "\n" + @" ""certified_entity_post_code"": ""string"", " + "\n" + @" ""certified_entity_country"": ""string"", " + "\n" + @" ""certified_entity_website"": ""string"", " + "\n" + @" ""tax_id"": ""string"", " + "\n" + @" ""business_registration_number"": ""string"", " + "\n" + @" ""company_id_number"": ""string"", " + "\n" + @" ""confidential_certified_entity"": ""string"", " + "\n" + @" ""accreditation_body_name"": ""string"", " + "\n" + @" ""accreditation_body_acronym_name"": ""string"", " + "\n" + @" ""schemes"": [ " + "\n" + @" { " + "\n" + @" ""scheme_name"": ""string"", " + "\n" + @" ""standard_list"": [ " + "\n" + @" { " + "\n" + @" ""standards_name"": ""string"" " + "\n" + @" } " + "\n" + @" ] " + "\n" + @" } " + "\n" + @" ], " + "\n" + @" ""sites"": [ " + "\n" + @" { " + "\n" + @" ""street"": ""string"", " + "\n" + @" ""city"": ""string"", " + "\n" + @" ""state"": ""string"", " + "\n" + @" ""country"": ""string"", " + "\n" + @" ""postcode"": ""string"", " + "\n" + @" ""scope_description"": ""string"" " + "\n" + @" } " + "\n" + @" ] " + "\n" + @"}"; request.AddParameter("application/json", body, ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); ``` {% endtab %} {% endtabs %}