Resolution

Resolution POST

POST
The resolution endpoints allow users to search for matching entities against a provided list of attributes. The endpoint is similar to the search endpoint, except it's tuned to only return the best match so the client doesn't need to do as much or any post-processing work to filter down results.

Query parameters

limitintegerOptional
A limit on the number of objects to be returned with a range between 1 and 10. Defaults to 10.
offsetintegerOptional
Number of results to skip before returning response. Defaults to 0.

Request

This endpoint expects an object.
name
list of stringsOptional
Entity name
identifier
list of unionsOptional
country
list of enumsOptional

Entity country - must be ISO (3166) Trigram i.e., USA. See complete list here

address
list of stringsOptional
Entity address
date_of_birth
list of stringsOptional
Entity date of birth
contact
list of stringsOptional
Entity contact
type
list of enumsOptional

Entity type. If multiple values are passed for any field, the endpoint will match entities with ANY of the values.

Response

This endpoint returns an object
fields
object
data
list of objects
POST
1curl -X POST "https://api.sayari.com/v1/resolution?limit=2" \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": [
6    "victoria beckham limited"
7  ]
8}'
200
Successful
1{
2  "fields": {
3    "name": [
4      "victoria beckham limited"
5    ]
6  },
7  "data": [
8    {
9      "profile": "corporate",
10      "score": 167.00832,
11      "entity_id": "mGq1lpuqKssNWTjIokuPeA",
12      "label": "VICTORIA BECKHAM LIMITED",
13      "type": "company",
14      "identifiers": [
15        {
16          "value": "06517802",
17          "type": "uk_company_number",
18          "label": "Uk Company Number"
19        },
20        {
21          "value": "04781466",
22          "type": "ca_corporate_id_num",
23          "label": "Ca Corporate Id Num"
24        },
25        {
26          "value": "6517802",
27          "type": "unknown",
28          "label": "Unknown"
29        }
30      ],
31      "addresses": [
32        "202 HAMMERSMITH ROAD , LONDON , , UNITED KINGDOM , W6 7DN , GB",
33        "Unit 33, Ransomes Dock Business Centre, 35-37 Parkgate Road, London SW11 4NP",
34        "SAUNDERS BUILDING, 202 HAMMERSMITH ROAD, HAMMERSMITH, LONDON",
35        "Ransome's Dock, 35-37 Parkgate Road, London, SW11 4NP",
36        "Hammersmith Road, London, W6 7DN",
37        "202 HAMMERSMITH ROAD UNITED KINGDOM",
38        "202 HAMMERSMITH ROAD BRITISH ISLES"
39      ],
40      "countries": [
41        "GBR",
42        "USA",
43        "VNM"
44      ],
45      "sources": [
46        "2b618f1996252fe537a6d998ae14c9b2",
47        "2b788dbdf9194ed5a5c309386a6516b1",
48        "a447a7b622c4ead6e1caf94983dc2337",
49        "ecdfb3f2ecc8c3797e77d5795a8066ef",
50        "e5de7b52cc88ef4cd1a10e201bdf46ee",
51        "2a4fe9a14e332c8f9ded1f8a457c2b89",
52        "ecdfb3f2ecc8c3797e77d5795a8066ef",
53        "4ea8bac1bed868e1510ffd21842e9551"
54      ],
55      "typed_matched_queries": [
56        "name|0",
57        "looseName|0"
58      ],
59      "matched_queries": [
60        "name"
61      ],
62      "highlight": {
63        "name": [
64          "<em>VICTORIA</em> <em>BECKHAM</em> LIMITED",
65          "<em>BECKHAM</em> VENTURES LIMITED"
66        ]
67      },
68      "explanation": {
69        "name": [
70          {
71            "matched": "<em>VICTORIA</em> <em>BECKHAM</em> LIMITED",
72            "uploaded": "victoria beckham limited"
73          },
74          {
75            "matched": "<em>BECKHAM</em> VENTURES LIMITED",
76            "uploaded": "victoria beckham limited"
77          }
78        ]
79      },
80      "match_strength": {
81        "value": "weak"
82      },
83      "psa_id": 695785012897
84    },
85    {
86      "profile": "corporate",
87      "score": 163.52704,
88      "entity_id": "v7fh4Kv5aLpfk7ld8oul2w",
89      "label": "VICTORIA BY VICTORIA BECKHAM",
90      "type": "intellectual_property",
91      "identifiers": [
92        {
93          "value": "11314607",
94          "type": "chn_cnipa_tm",
95          "label": "Chn Cnipa Tm"
96        }
97      ],
98      "addresses": [],
99      "countries": [
100        "CHN"
101      ],
102      "sources": [
103        "8f50655ba1d1552ab4b89d119bd9c318"
104      ],
105      "typed_matched_queries": [
106        "name|0",
107        "looseName|0"
108      ],
109      "matched_queries": [
110        "name"
111      ],
112      "highlight": {
113        "name": [
114          "<em>VICTORIA</em> BY <em>VICTORIA</em> <em>BECKHAM</em>"
115        ]
116      },
117      "explanation": {
118        "name": [
119          {
120            "matched": "<em>VICTORIA</em> BY <em>VICTORIA</em> <em>BECKHAM</em>",
121            "uploaded": "victoria beckham limited"
122          }
123        ]
124      },
125      "match_strength": {
126        "value": "weak"
127      }
128    }
129  ]
130}
Built with