Address, Website audit reports & Social Profile of companies
To retrieve address, website audit reports or social profile on KYB companies, the functionality has to be enabled for the environment that you use.
Our sales@idenfy.com team will help you include new functionalities in your contract and the technical support team will help with enabling these new features and assist throughout the implementation. Please contact our technical support team via Dashboard using your account.
To make the API calls, all of the requests will require basic auth, where API key is username, and API secret is password.
Address audit
To perform address audit for the company, construct a POST request to the following endpoint:
https://ivs.idenfy.com/api/v2/audits/address-audit/
Request structure:
Parameter | Type | Required | Explanation |
---|---|---|---|
address | String | Yes | Address for audit |
Samples
- Request example
- Response example
{
"address": "string"
}
{
"googleMapsUrl":"http://example.com",
"dataId":"string",
"type":{
"property1":null,
"property2":null
},
"address":"string",
"associatedBodies":{
"property1":null,
"property2":null
},
"latitude":0,
"longitude":0,
"addressAuditImages":[{}],
"riskScore":0
}
Website audit
To perform website audit of the company, construct a POST request to the following endpoint:
https://ivs.idenfy.com/api/v2/audits/website-audit/
Request structure:
Parameter | Type | Required | Explanation |
---|---|---|---|
url | String | Yes | Valid URL address of the website |
Samples
- Request example
- Response example
{
"url": "http://example.com"
}
{
"url": "http://example.com",
"riskLevel": "VERY_LOW",
"trustScore": 0,
"blacklistScore": 0,
"internalAuditScore": 0,
"popularityScore": 0,
"domainCreatedAt": "2019-08-24T14:15:22Z",
"image": "http://example.com",
"websiteTitle": "string",
"websiteDescription": "string"
}
Company social audit
To perform company social audit, construct a POST request to the following endpoint:
https://ivs.idenfy.com/api/v2/audits/company-name-audit/
Request structure:
Parameter | Type | Required | Explanation |
---|---|---|---|
address | String | Yes | Registration address of the company |
companyName | String | Yes | Name of the company |
Samples
- Request example
- Response example
{
"address": "string",
"companyName": "string"
}
{
"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08",
"descriptionByCompany":"string",
"address":"string",
"phoneNumber":"string",
"industry":"string",
"rating":0,
"socialMediaProfiles":{
"property1":null,
"property2":null
},
"companyName":"string",
"reviews":[{}]
}