API Methods

The Experian Connector uses API methods to retrieve company credit data. The methods are detailed below.

 

This method returns company general commercial credit information. The call is made using the FTOS_EXTD_EXPE_CommercialCredit endpoint.

Call Example

Request:

Copy
{
    "ApiInfo": {
        "Token": "{{access_token}}"
    },
    "Request": {
        "ActionName": "FTOS_EXTD_EXPE_CommercialCredit", 
        "Data": "{\"name\": \"TEST\", \"postCode\": \"\", \"postTown\": \"\", \"phoneNumber\": \"\", \"businessRef\": \"\", \"searchCorporates\": false, \"excludeDissolved\": false, \"searchNonCorps\": true }"
    }
}
 

Response:

 
Copy
{
    "UIResult": {
        "NavigateToEntityPage": false,
        "NavigateToEntityPageOnEdit": false,
        "NavigateToEntityFormName": null,
        "NavigateToEntityName": null,
        "NavigateToEntityId": null,
        "NavigateToEntityInsertDefaults": null,
        "NavigateToUrl": null,
        "DownloadFile": null,
        "ReloadPage": false,
        "Message": null,
        "IsSuccess": false,
        "Data": "{\"SearchSummary\":{\"businessRef\":null,\"phoneNumber\":null,\"businessName\":\"TEST\",\"postTown\":null,\"numberMatches\":\"2\",\"postcode\":null},\"SearchResults\":[{\"locationLine3\":\"NOTTINGHAM\",\"matchedPhoneNumber\":null,\"description\":\"HARDWARE CONSULTANCY\",\"legalEntity\":null,\"postcode\":\"NG80 1ZZ\",\"businessStatus\":\"A\",\"locationLine1\":\"THE SIR JOHN PEACE BUILDING\",\"matchedPostcode\":null,\"locationLine4\":null,\"locationLine2\":\"EXPERIAN WAY\",\"businessRef\":\"99999999\",\"name\":\"TEST LIMITED\",\"locationLine5\":null,\"codeType\":\"B\",\"SICCode\":\"7210\",\"nameType\":\"RC\",\"commercialName\":\"TEST LIMITED\",\"businessActivities\":null},{\"locationLine3\":\"NOTTINGHAM\",\"matchedPhoneNumber\":null,\"description\":\"MANAGEMENT ACTIVITIES HOLDING COMPS\",\"legalEntity\":null,\"postcode\":\"NG80 1ZZ\",\"businessStatus\":\"A\",\"locationLine1\":\"THE SIR JOHN PEACE BUILDING\",\"matchedPostcode\":null,\"locationLine4\":null,\"locationLine2\":\"EXPERIAN WAY\",\"businessRef\":\"99999998\",\"name\":\"TEST (COMPANY 2) LIMITED\",\"locationLine5\":null,\"codeType\":\"B\",\"SICCode\":\"7415\",\"nameType\":\"RC\",\"commercialName\":\"TEST (COMPANY 2) LIMITED\",\"businessActivities\":null}]}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}

This method returns credit information for UK registered companies. The call is made using FTOS_EXTD_EXPE_RegCompCredit.

Request Call Example:

Copy
{
    "ApiInfo": {
        "Token": "{{access_token}}"
    },
    "Request": {
        "ActionName": "FTOS_EXTD_EXPE_CommercialCredit", 
        "Data": "{\"name\": \"TEST\", \"postCode\": \"\", \"postTown\": \"\", \"phoneNumber\": \"\", \"businessRef\": \"\", \"searchCorporates\": false, \"excludeDissolved\": false, \"searchNonCorps\": true }"
    }
}