API Credit Consumption

Overview

The IAF CertSearch Verification API uses a credit-based consumption model. Understanding when a credit is consumed and when it is not, is essential for managing costs and planning your integration effectively.

Core rule: A verification credit is consumed once per company when the API returns an exact match. No match, no charge.

What Is an Exact Match?

An exact match occurs when the API identifies a Certified Entity with a match score of 94–100 (Very High band), returning match_type: exactly_matched. Results scoring 30–93 are returned as loosely_matched — they appear in the response but do not consume a credit.

Match Score Bands

Band
Score Range
match_type
Credits Consumed

Very High

94 – 100

exactly_matched

✅ Yes

High

80 – 93

loosely_matched

🚫 No

Medium

60 – 79

loosely_matched

🚫 No

Low

30 – 59

loosely_matched

🚫 No

Very Low

0 – 29

not matched

🚫 No

Match Rate Rules

Parameter

Value / Behaviour

Default match rate

94 (applied when not provided)

Minimum accepted rate

30, values below 30 are automatically raised to 30

Valid range

30 – 100

Rate > 100

Automatically capped at 100

When a Credit IS Consumed

✅ Credit Consumed

A credit is deducted from your balance when the following conditions are all true:

  1. The API request is well-formed and authenticated.

  2. The system finds a Certified Entity with a match score of 94 or above (match_type: exactly_matched).

  3. The API returns a 200 OK response with company and certificate data.

When a Credit Is NOT Consumed

🚫 Credit NOT Consumed

No credit is deducted in any of these situations:

  1. No match found, the API returns a 404 not_found response. The company could not be identified in the database.

  2. Match found but score is 30–93 (match_type: loosely_matched). The result is returned for review but no credit is charged.

  3. Authentication failure, invalid or missing API key (401 unauthorized).

  4. Validation error, malformed request body (400 validation).

  5. Re-verification within the grace period, accessing the same company again within your subscription grace period costs nothing.

Credit Consumption by API Endpoint

The table below summarises how credits are consumed across each Verification API endpoint.

API
Endpoint
Credits Consumed
Notes

Retrieve Company & Certificates

POST /company

1 per exact match

Retrieve Company & Certificates by name / identifiers. One credit per matched company.

Bulk Retrieve Companies & Certificates

POST /bulk-companies

1 per exact match

Bulk Retrieve, each company in the batch that returns an exact match consumes 1 credit.

Match Companies

POST /match-companies

None

Match Companies endpoint, company matching only, no certificate data returned. No credits are charged.

Retrieve Company & Certificates by IAF ID

GET /company/{ce_id}

1 per exact match

Retrieve Company & Certificates by IAF ID. A valid IAF ID always resolves; 1 credit charged.

Bulk Retrieve Company & Certificates by IAF ID

POST /bulk-company-by-id

1 per exact match

Bulk Retrieve by IAF ID, 1 credit per valid IAF ID that returns data.

Retrieve Certificate by IAF ID

GET /certificate/{cert_id}

1 per exact match

Retrieve Certificate by IAF ID. Returns a single certificate record; 1 credit consumed on success.

💡 Key Point

Credits are charged at the company level, not the certificate level. A company with 10 certificates still costs only 1 credit to verify. All certificates under that company are returned in the same response at no additional cost.

Last updated