For the complete documentation index, see llms.txt. This page is also available as Markdown.

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 or company_identifiers, must be provided.

  • Match Rate Value:

    • The default rate value is 94 when no match_rate is provided.

    • If an invalid (non-numeric) match_rate is submitted, it falls back to 30.

    • The minimum accepted value is 30; values below 30 are enforced to 30.

    • Valid rate values range from 30 to 100.

    • Any rate value exceeding 100 will automatically be capped at 100.

  • Match Score Bands:

    • The match score (0–100) is grouped into bands that determine the match_type:

    Band
    Score Range
    match_type

    Very High

    94 – 100

    exactly_matched

    High

    80 – 93

    loosely_matched

    Medium

    60 – 79

    loosely_matched

    Low

    30 – 59

    loosely_matched

    Very Low

    0 – 29

    not matched

  • Match Type:

    • match_type is derived from the match score band:

      • exactly_matched — score 94–100 (Very High band). Credits are consumed and the verified data is saved to the company's default list.

      • loosely_matched — score 30–93 (High, Medium, or Low band). The result is returned for review but is not saved to the default list and does not consume credits.

  • Match Factors:

    • match_factors is an object of booleans indicating which submitted fields contributed to the match. Each flag is true when that field matched the Certified Entity:

      • company_name — the submitted company name matched the Certified Entity name.

      • company_english_name — matched the Certified Entity's English name.

      • company_trading_name — matched the Certified Entity's trading name.

      • company_identifiers — one or more submitted identifiers matched.

      • country — the submitted country matched.

      • city — the submitted city matched.

  • Response Value:

    • The API will return a single matched Certified Entity record with its Certificates.

Headers

Name
Type
Description

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

Name
Type
Description

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_city

String

Optional city of the main entity address. When provided, companies in that city receive a higher match score.

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"

}

Country-aware identifiers (vat, tax_id, business_registration_number) are matched within the specified company_country. Global identifiers (duns_number, company_id_number) match across all countries.

match_rate

Number / String

The minimum match score threshold for a result to be returned. Example: 100 | "100%"

Example Payload Request

Responses

Request Successful

Last updated