API reference

Get a merchant

GET/v1/merchants/{id}

Parameters

Field	Type	Description
`id`requiredpath	string	Merchant ID from an enrichment result, e.g. `mer_01J...`.

Response

Field	Type	Description
`request_id`required	string	Unique ID of this request.
`id`required	string
`name`required	string
`slug`required	string
`legal_name`	string \| null
`website`	string \| null
`logo_url`	string \| null
`category`required	string
`subcategory`	string \| null
`mcc`	string \| null
`country`	string \| null	Home market
`verified`required	boolean

Status codes

200
The merchant record.
401
Missing, invalid or revoked API key, or a suspended account.
Error code unauthorized
404
The resource does not exist.
Error code not_found
429
Too many requests per second. Retry after the number of seconds in Retry-After.
Error code rate_limited

Try it

Runs through the playground, no key needed

Request

curl https://api.descriptorapi.com/v1/merchants/mer_01JABCDEF0123456789ABCDEFG \
  -H "Authorization: Bearer $DESCRIPTORAPI_KEY"

req, _ := http.NewRequest("GET", "https://api.descriptorapi.com/v1/merchants/mer_01JABCDEF0123456789ABCDEFG", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("DESCRIPTORAPI_KEY"))
resp, err := http.DefaultClient.Do(req)

const res = await fetch("https://api.descriptorapi.com/v1/merchants/mer_01JABCDEF0123456789ABCDEFG", {
  headers: {
    Authorization: `Bearer ${process.env.DESCRIPTORAPI_KEY}`,
  },
});
const data = await res.json();

import os, requests

res = requests.yget(
    "https://api.descriptorapi.com/v1/merchants/mer_01JABCDEF0123456789ABCDEFG",
    headers={"Authorization": f"Bearer {os.environ['DESCRIPTORAPI_KEY']}"},
    timeout=10,
)
data = res.json()

$ch = curl_init("https://api.descriptorapi.com/v1/merchants/mer_01JABCDEF0123456789ABCDEFG");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('DESCRIPTORAPI_KEY')],
]);
$data = json_decode(curl_exec($ch), true);

Response · 200 OK

{
  "request_id": "req_01JABCDEF0123456789ABCDEFG",
  "id": "mer_01JABCDEF0123456789ABCDEFG",
  "name": "string",
  "slug": "string",
  "legal_name": "string",
  "website": "https://example.com",
  "logo_url": "https://example.com",
  "category": "string",
  "subcategory": "string",
  "mcc": "string",
  "country": "string",
  "verified": false
}