Bulk Upload Certification
Last updated
Last updated
POST https://api.iafcertsearch.org/api/client/v1/cb/bulk-upload-cert
Fields that are marked with an asterisk (*) are mandatory.
The symbol ([*]) is used to indicate that a particular field is part of an array of certification objects.
The maximum number of Certification records you can upload at a time is 100.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Bulk Upload Certification
We recommend to have an interval of 10 minutes 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/v1/cb/bulk-upload-cert to test it on the Sandbox server.
Take a look at how you might call this method:
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>>
certifications.[*]*
String
{
"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.
certifications.[*].certificate_accreditation_status
String
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.
certifications.[*].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.
certifications.[*].certification_original_issue_date
String
Original certification date (YYYYMMDD). Example: 20170203
certifications.[*].certification_issue_date*
String
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
certifications.[*].certified_entity_name*
String
Certified Entity Name (company name) as detailed on the certificate. Example: Test Food and Logistics Inc. Reliable Logistics Services Inc.
certifications.[*].certified_entity_english_name
String
Certified Entity English Name Example: Test Food and Logistics Inc. English Name Reliable Logistics Services Inc. English Name
certifications.[*].certified_entity_trading_name
String
Certified Entity Trading Name Example: Test Food and Logistics Inc. Trading Name Reliable Logistics Services Inc. Trading Name
certifications.[*].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
certifications.[*].certified_entity_street_address
String
The main entity address for the certified entity.
certifications.[*].certified_entity_street_city
String
City of the main entity address for the certified entity.
certifications.[*].certified_entity_state
String
State of the main entity address for the certified entity. If no state, leave blank.
certifications.[*].certified_entity_post_code
String
Zip code or post code of the main entity address for the certified entity.
certifications.[*].certified_entity_country*
String
Country/Economy of the main entity address for the certified entity.
certifications.[*].certified_entity_website
String
Certified Entity Website
certifications.[*].accreditation_body_name*
String
Accreditation Body Name
certifications.[*].accreditation_body_acronym_name*
String
Accreditation Body Acronym
certifications.[*].confidential_certified_entity
String
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