Retrieve Company & Certificates
Retrieve Company & Certificates
Find company and certificates by name and match rate.
POST
/company
Fields that are marked with an asterisk (*
) are mandatory.
The API can only match one Certified Entity from IAFCertSearch per request.
Company Information Requirements:
At least one of the two fields,
company_name
orcompany_identifiers
, must be provided.
Match Rate Value:
The default rate value is set to 100.
The minimum acceptable rate value is 80, regardless of whether a lower threshold is specified.
Valid rate values range from 80 to 100, in increments of 5.
Any rate value exceeding 100 will automatically be capped at 100.
Response Value:
The API will return a single matched Certified Entity record with its Certificates.
Headers
Content-Type*
String
application/json
x-http-authorization*
String
API Key received from https://www.iafcertsearch.org/api-verification
Example:
x-http-authorization: <<API KEY>>
Request Body
company_country*
String
Country/Economy of the main entity address for the Certified Entity.
Supports full country name, alpha-2 and alpha-3 format (click for more information)
Example:
Australia | AU | AUS
company_name
String
Certified Entity Name (Company Name) as detailed on the Certificate.
company_identifiers
Object
Additional Company Fields
Format:
"company_identifiers": {
"vat": "string",
"tax_id": "string",
"business_registration_number": "string",
"duns_number": "string",
"company_id_number": "string"
}
match_rate
Number / String
The percentage or similarity score indicating how closely the details of two companies match during the verification process.
Example:
100 | "100%"
Example Payload Request
{
"company_name": "IAF",
"company_country": "Australia",
"company_identifiers": {
"vat": null,
"tax_id": null,
"business_registration_number": null,
"duns_number": null,
"company_id_number": null
},
"match_rate": 90
}
curl --location --globoff --request POST '{API_URL}/company' \
--header 'x-http-authorization: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"company_name": "string",
"company_country": "string",
"company_identifiers": {
"vat": "string",
"tax_id": "string",
"business_registration_number": "string",
"duns_number": "string",
"company_id_number": "string"
},
"match_rate": 90
}'
Responses
Request Successful
{
"data": {
"ce_id": string,
"matched_certified_entity_name": string,
"match_status": string,
"match_type": string,
"certified_entity_english_name": string,
"certified_entity_trading_name": string,
"country": string,
"certified_entity_addresses": [
{
"street": string,
"city": string,
"state": string,
"post_code": string,
"full_address": string,
"country": string
}
],
"certificates": [
{
"cert_id": string,
"accreditation_bodies_name": string,
"certification_bodies_name": string,
"certification_number": string,
"certification_status": string,
"certification_scope": string,
"certification_standards_scheme": [
{
"standard_name": string,
"scheme_name": string,
"is_accredited_mla": boolean
}
],
"certification_main_sites": [
{
"street": string,
"city": string,
"state": string,
"post_code": string,
"full_address": string,
"scope": string,
"country": string
}
],
"certification_additional_sites": [
{
"street": string,
"city": string,
"state": string,
"post_code": string,
"full_address": string,
"scope": string,
"country": string
}
],
"certification_sectors": [
{
"sector_name": string,
"sector_code": string
}
],
"updated_at": integer
}
]
}
}
Last updated