Upload Certification
Upload Certification
POST https://api.iafcertsearch.org/api/client/v2/cb/upload-cert
Fields that are marked with an asterisk (*) are mandatory.
Headers
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
certified_entity.*
String
{
"certified_entities" : {
"certified_entity_unique_id": "string",
"certified_entity_name": "string",
. . . .
}
}
certified_entities.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_entities.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_entities.certified_entity_english_name
String
Certified Entity English Name Example: Test Food and Logistics Inc. English Name Reliable Logistics Services Inc. English Name
certified_entities.certified_entity_trading_name
String
Certified Entity Trading Name Example: Test Food and Logistics Inc. Trading Name Reliable Logistics Services Inc. Trading Name
certified_entities.business_registered_street
String
Street of the main entity address for the certified entity. Rule: If business_registered_full_address is NULL AND business_registered_city is NULL THEN business_registered_street should be REQUIRED.
certified_entities.business_registered_city
String
City of the main entity address for the certified entity. Rule: If business_registered_full_address is NULL AND business_registered_street is NULL THEN business_registered_city should be REQUIRED.
certified_entities.business_registered_state
String
State of the main entity address for the certified entity. If no state, leave blank.
certified_entities.business_registered_zip_code
String
Zip code or post code of the main entity address for the certified entity.
certified_entities.business_registered_country*
String
Country/Economy of the main entity address for the certified entity.
certified_entities.business_registered_full_address
String
Full Address of the main entity address for the certified entity. Rule: If business_registered_street is NULL
AND business_registered_city is NULL THEN
business_registered_full_address should be REQUIRED.
certified_entities.confidential_certified_entity
String
Where the confidentiality of the Certified Entity is defined. Accepted Values: Yes
No
certified_entities.certified_entity_website
String
Certified Entity Website
certified_entities.tax_id
String
Tax Identification
Example:
000123456001
certified_entities.company_id_number
String
Company Identification Number
Example:
U12345ABCDE12345F123456
certified_entities.business_registration_number
String
Business Registration Number
Example:
1234567890A
certified_entities.vat
String
Vat Example:
GB123456789
certified_entities.duns_number
String
Duns Number Example: 987654321
certification.*
{
"certifications" : {
"certificate_number": "string",
"certification_status": "string",
. . . .
}
}
certification.certificate_identity_number*
String
Certificate Identity Number
A unique identifier that provides a more secure form of identification.
certification.certificate_number*
String
Certificate number shown on the certificate itself.
certification.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.
certification.certificate_accreditation_status
String
Has this certificate been issued under and existing accreditation or is this an unaccredited certificate. Accepted values:
Accredited
Unaccredited
certification.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.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.flexible_scope
String
Flexible Scope
certification.certification_original_issue_date
String
Original certification date (YYYYMMDD). Example: 20170203
certification.certification_issue_date*
String
Most recent certification date as detailed on the certificate (YYYYMMDD). Example:
20170203
certification.certification_expiry_date*
String
Certification expiry date as detailed on the certificate (YYYYMMDD). Example: 20170203
certification.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
certification.main_site_street
String
Street of the main entity address for the certification. Rule: If main_site_full_address is NULL AND main_site_city is NULL THEN main_site_street should be REQUIRED.
certification.main_site_city
String
City of the main entity address for the certification. Rule: If main_site_full_address is NULL AND main_site_street is NULL THEN main_site_city should be REQUIRED.
certification.main_site_state
String
State of the main entity address for the certification. If no state, leave blank.
certification.main_site_zip_code
String
Zip code or post code of the main entity address for the certification.
certification.main_site_country*
String
Country/Economy of the main entity address for the certification.
certification.main_site_full_address
String
Full Address of the main entity address for the certification. Rule: If main_site_street is NULL
AND main_site_city is NULL THEN
main_site_full_address should be REQUIRED.
certification.confidential_certified_entity
Boolean
Where the confidentiality of the Certified Entity is defined. Accepted Values: Yes
No
certification.accreditation_body_name*
String
Accreditation Body Name
certification.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.
certification.schemes*
Array
Certification Schemes Example:
{
"schemes": [
{
"scheme_name": "string",
"standard_list": [
{
"standards_name": "string"
}
]
}
]
}
certification.cert_sites
Array
Certification Sites Example:
{
"cert_sites": [
{
"certified_entity_unique_id: "string",
"site_type": "string"
"street": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country": "string",
"full_address": "string",
"scope": "string
}
]
}
To delete all existing sites of a certification, set the value of the sites key to an empty array like so:
{
"cert_sites": []
}
certification.sectors
Array
Certification Technical Sectors
Example:
{
"sectors: [
{
"sector_name": "string",
"sector_code": "string",
}
]
}
To delete all existing sectors of a certification, set the value of the sectors key to an empty array like so:
{
"sectors": []
}
Upload Certification
We recommend to have an interval of 1 minute in between API requests to avoid errors during certification data publication.
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/v2/cb/upload-cert to test it on the Sandbox server.
Take a look at how you might call this method:
Last updated