Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
There are several ways you can get started with the IAFCertSearch Verification Users API.
Before you can start using the API, you need to do the following:
Create/Activate an IAF CertSearch account.
Generating an API Key
To generate the API Key, go to API Settings from the left navigation. Under the Generate API Key section, click the Generate API Key button.
Make sure you have curl installed on your machine.
To authenticate, add an x-http-authorization header to your API request that contains an API Key.
IAF CertSearch’s Verification Users API supports the use of API Keys. API Keys allow you to use another method of authentication separate from your account username and password. API Keys add an additional layer of security for your account and can be assigned to limit which areas of your account can be accessed. API Keys can be generated in your account. To use keys, you must set a plain text header named “x-http-authorization” with the contents of the header being “(API Key)” where (API Key) is your API Secret Key.
For more information about the API URL, see the requests page.
All responses are returned in JSON format. We specify this by sending the Content-Type
header.
Below is a table containing descriptions of the various status codes we currently support against various resources.
200
OK / Partial Success
201
Resource Created
202
Accepted
400
Bad Request / Validation Error
401
Unauthorized
403
Forbidden
404
Resource Not Found
405
Method Not Allowed
406
Not Acceptable
422
Unprocessable Entity
429
Too Many Requests
500
Internal Server Error
When a request is made with a pagination query, the meta data is included in the response to allow for easy traversal of previous, current, first, and last page of the data set.
POST
/bulk-certified-entities
Fields that are marked with an asterisk (*
) are mandatory.
The API can match multiple Certified Entities from IAFCertSearch per request.
Certified Entity Requirements:
icsce_ids
must be provided.
The maximum number of icsce_ids
that this endpoint accepts is 1000.
Response Value:
The API will return a list of matched Certified Entities with its Certificates.
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>>
icsce_ids
Array of strings
ID of the companies or Certified Entities. Example: { "icsce_ids": [ "mdbce_O8fEcGngmWwaU9OOKxGlR2gV" ] } The maximum number of IDs that this endpoint accepts is 1000.
POST
/verify-companies
Fields that are marked with an asterisk (*
) are mandatory.
The API can match one or multiple Certified Entities 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 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.
Match Result Count Value:
The default value is set to 3.
The minimum acceptable value is 1.
The maximum acceptable value is 10.
Any value exceeding 10 will automatically be capped at 10.
Response Value:
The API will only return a single matched Certified Entity record with its Certificates if:
The match rate value is set to 100.
The system only finds 1 matched Certified Entity record.
Otherwise, the API will return multiple matched Certified Entity records without its Certificates.
If company_identifiers
are provided, it will be included in the response.
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>>
company_country*
String
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%"
match_result_count
Number / String
The maximum count of returned matched results.
Example:
10
Country/Economy of the main entity address for the Certified Entity. (click for more information) Example: Australia | AU | AUS
GET
/certified-entities/{icsce_id}
Fields that are marked with an asterisk (*
) are mandatory.
Certified Entity Requirements:
The API requires the icsce_id
of a Certified Entity.
Multiple Certified Entities can be verified in one request by providing a comma separated string value for icsce_id
.
The maximum number of icsce_id
that this endpoint accepts is 100.
Response value:
The API will return matched Certified Entity records with its Certificates.
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>>
icsce_id*
String
The ID of the Company or Certified Entity.
Example:
mdbce_KMi1zsb9CH2EorSzOJ9YEgtV
To verify multiple Companies using their IDs, separate them with comma ( , ).
Example:
mdbce_KMi1zsb9CH2EorSzOJ9YEgtV,mdbce_KMi1zsb9CH2EorSzOJ9YEgtV
The maximum number of IDs that this endpoint accepts is 100.
Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request.
Status Code Description
400 Bad request
401 Requires authentication
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Missing Accept header. For example: Accept: application/json
429 Too many requests/Rate limit exceeded
500 Internal server error
The general format guidelines are displayed when the accompanying status code is returned.
To access the API URL, log in to your IAF CertSearch account and go to the API settings page.
All requests must be made over HTTPS. The API does not support HTTP.
You must provide an authorization header as described in Authentication.
GET
Retrieve a resource or group of resources
POST
Create a new resource
PUT
Update an existing resource
DELETE
Delete an existing resource
OPTIONS
View allowed verbs against a specific resource
The API provides JSON responses. It doesn’t currently require the accept header, but might in the future. If not set, the API will use application/json
.
When you send an array of data in a GET
request, you will include the parameter multiple times on the URL. The parameter name does not require brackets.
When submitting data to a resource via POST
or PUT
, you must submit your payload in JSON.
Some GET
resources allow for retrieval of information in batches. We will provide the query parameters in the resource documentation when applicable.
When requesting multiple items, we will default the request limit
to 20
items. You can specify a different limit using the limit
parameter when you need to. The maximum value for the limit
parameter that we accept is 100
.
Below you can see an example of an API request which retrieves the first 100 records as specified by the limit=100
and offset=0
parameters.
To retrieve the next batch of records, increment the offset parameter by 1
.
Verb
Resource object returned
GET
Returns a single resource object or array of resource objects
PATCH
Returns the updated resource object
PUT
Returns the updated resource object
DELETE
No content is returned
POST
Returns the newly created resource object
POST
/bulk-verify-companies
Fields that are marked with an asterisk (*
) are mandatory.
The API accepts multiple Company Information and can match multiple Certified Entities from IAFCertSearch per request.
Companies:
The companies
must be provided.
The maximum number of company data that this endpoint accepts is 100.
Companies 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 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 list of matched Certified Entities with its Certificates.
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>>
companies
Array of Objects
Array of companies to be matched The maximum number of company data that this endpoint accepts is 100
companies.*company_country*
String
companies.*.company_name
String
Certified Entity Name (Company Name) as detailed on the Certificate.
companies.*.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%"
GET
/certificates/{icscert_id}
Fields that are marked with an asterisk (*
) are mandatory.
Certificate Information Requirements:
The API requires the icscert_id
of a Certificate.
Response value:
The API will return a single matched Certificate record.
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>>
icscert_id*
String
The ID of the Certificate.
Example:
mdbcert_GuFIQmBnjaNG8Xvz7Q3DeBVx
POST
/verify-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 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.
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>>
company_country*
String
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%"
Country/Economy of the main entity address for the Certified Entity.
(click for more information)
Example:
Australia | AU | AUS
Country/Economy of the main entity address for the Certified Entity.
(click for more information)
Example:
Australia | AU | AUS