Skip to main content
POST
/
entities
/
resolve
Find entity by name
curl --request POST \
  --url https://api.ledgerbeam.com/v1/entities/resolve \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Apple"
}'
{
  "id": "6890b942-df95-43f5-8f38-a5dcee46d24a",
  "name": "Apple",
  "type": "merchant",
  "website": "https://www.apple.com",
  "logo": "https://logos.ledgerbeam.com/www.apple.com",
  "description": "Apple is a multinational technology company...",
  "intermediaries": []
}

​
Overview

Find an entity by its name. This endpoint allows you to search for entities in the LedgerBeam database using their name.

Authorizations

​
API-KEY
string
header
required

API key for authentication

Body

application/json
​
name
string
required

Entity name to search for

Example:

"Apple"

Response

Entity found successfully

​
id
string

Entity ID

Example:

"6890b942-df95-43f5-8f38-a5dcee46d24a"

​
name
string

Entity name

Example:

"Apple"

​
type
enum<string>

Entity type

Available options:
merchant,
person,
organization
Example:

"merchant"

​
website
string<uri>

Entity website

Example:

"https://www.apple.com"

Entity logo URL

Example:

"https://logos.ledgerbeam.com/www.apple.com"

​
description
string

Entity description

Example:

"Apple is a multinational technology company..."

​
intermediaries
string[]

List of payment processors or intermediaries

Example:
[]