GET /v1/token/report

HTTP Method: GET

Path: /v1/token/report

Authentication: API Key required

Description: Get a URL that allows a user to report incorrect information on an existing entity (Index Card) in the Central Index.

Parameters:

parameter type description Required
entity_id string The unqiue identifier of the entity to edit e.g. 379236608286720 Yes
portal_name string The name of the website that data is to be added on E.g. Your Local Yes
language string An ISO compatible language code. (Default is en) No

Sample Response:

{
    "success": true,
    "msg": "Token Url",
    "data": "http://admin.centralindex.com/report?token=8d04114851ca8c5aef0e56f50a224235aa7793fbbf4afd0531c95fcab088639d1fccbe404d17d42933ac0802c0c73877"
}

The API call returns a URL which your user's browser can be redirected to, in order for them to report objects on the entity as incorrect

Because this is a key-specific URL, the Central Index knows when an object is reported via your application.

You can see an example of how this works here:http://www.yourlocal.ie/company/379247505477632 Click on the "report a problem with this business" under the main contact details to see the report path in action.

version 11 as of 6 years ago by Richard Vaughan

Docs Navigation