API Key received from
Example:
x-http-authorization: <\
{
"certifications" : \[
{
"certificate\_number": "string",
"certification\_status": "string",
. . . .
}
]
}
| | certifications.\[\*].certificate\_number\* | String | Certificate number shown on the certificate itself. | | certifications.\[\*].certificate\_identity\_number | String |Certificate Identity Number
A unique identifier that provides a more secure form of identification.
| | certifications.\[\*].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.
Has this certificate been issued under and existing accreditation or is this an unaccredited certificate.
Accepted values:
Accredited
Unaccredited
| | certifications.\[\*].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
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.
Original certification date (YYYYMMDD).
Example:
20170203
Most recent certification date as detailed on the certificate (YYYYMMDD).
Example:
20170203
| | certifications.\[\*].certification\_expiry\_date\* | String |Certification expiry date as detailed on the certificate (YYYYMMDD).
Example:
20170203
Certified Entity Name (company name) as detailed on the certificate.
Example:
Test Food and Logistics Inc.
Reliable Logistics Services Inc.
Certified Entity English Name
Example:
Test Food and Logistics Inc. English Name
Reliable Logistics Services Inc. English Name
Certified Entity Trading Name
Example:
Test Food and Logistics Inc. Trading Name
Reliable Logistics Services Inc. Trading Name
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
Where the confidentiality of the Certified Entity is defined.
Accepted Values:
Yes
No
| | certifications.\[\*].schemes\* | Array |Certification Schemes
Example
{
"schemes": \[
{
"scheme\_name": "string",
"standard\_list": \[
{
"standards\_name": "string"
}
]
}
]
}
| | certifications.\[\*].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": \[]
}
| | certifications.\[\*].company\_id\_number | String |Company Identification Number
Example:
U12345ABCDE12345F123456
| | certifications.\[\*].business\_registration\_number | String |Business Registration Number
Example:
1234567890A
| | certifications.\[\*].tax\_id | String |Tax Identification
Example:
000123456001
| {% tabs %} {% tab title="200: OK Request successful." %} ```json { "data": { "success": true } } ``` {% endtab %} {% tab title="400: Bad Request Other errors that is described in the API response." %} ```json { "data": { "errors": { "record_index": 0, "errors": [ { "message": "error_message", "code": "error_code", "meta": { "field_name": "input" } } ] } } } ``` {% 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" %} **Bulk Upload Certification** We recommend to have an interval of 10 minutes 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 usecurl --location --request POST 'https://api.iafcertsearch.org/api/client/v1/cb/bulk-upload-cert' \
--header 'Content-Type: application/json' \
--header 'x-http-authorization: <<API_KEY>>' \
--data-raw '{
"certifications": [
{
"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",
"accreditation_body_name": "string",
"accreditation_body_acronym_name": "string",
"confidential_certified_entity": "string",
"tax_id": "string",
"business_registration_number": "string",
"company_id_number": "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 axios = require('axios');
var data = JSON.stringify({
"certifications": [
{
"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",
"accreditation_body_name": "string",
"accreditation_body_acronym_name": "string",
"confidential_certified_entity": "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/bulk-upload-cert',
headers: {
'Content-Type': 'application/json',
'x-http-authorization': '<<API_KEY>>'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});