Skip to main content
POST
/
identify
Look up the caller
curl --request POST \
  --url https://ringup.dev/api/tools/identify \
  --header 'X-Caller-Number: <x-caller-number>' \
  --header 'X-Ringup-Merchant: <x-ringup-merchant>'
{
  "known": true,
  "name": "Alex",
  "card": {
    "brand": "VISA",
    "last_4": "5858",
    "exp_month": 7,
    "exp_year": 2028
  }
}

Headers

​
X-Caller-Number
string
required

The caller's phone number in E.164, templated from the platform's caller-ID variable. Never model-generated.

Example:

"+14155550142"

​
X-Ringup-Merchant
string
required

The dialed number in E.164 (resolved to a merchant server-side) or an explicit merchant id.

Example:

"tonys-pizza"

​
X-Call-Id
string

The platform's call id. Used for charge idempotency: retries within a call can never double-charge.

Response

200 - application/json

The caller's saved-card status.

​
known
boolean
​
name
string
​
card
object