Retrieve business verification

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getpalm.com/v1/business/{business_id}/verification/{verification_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/business/{business_id}/verification/{verification_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.getpalm.com/v1/business/{business_id}/verification/{verification_id} \
  --header 'Authorization: Bearer <token>'

{
  "verification_id": "550e8400-e29b-41d4-a716-446655440000",
  "business_id": "bus_abc123",
  "status": "completed",
  "mode": "live",
  "risk": {
    "level": "low",
    "reasons": [
      "Business status is dissolved",
      "Submitted EIN does not match IRS records",
      "Business registered less than 90 days ago"
    ]
  },
  "match": {},
  "created_at": "2025-10-24T10:30:00Z",
  "reference_id": "biz_12345",
  "associates": [
    {
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "verification_id": "660f9511-f30c-52e5-b827-557766551111",
      "status": "completed",
      "mode": "live",
      "risk": {
        "level": "low",
        "reasons": [
          "Elevated synthetic-fraud score",
          "Identity could not be verified against authoritative records",
          "SSN does not match authoritative records",
          "Multiple core identity fields did not match authoritative records"
        ]
      },
      "match": {},
      "created_at": "2025-10-24T10:30:00Z",
      "reference_id": "user_12345",
      "synthetic": {
        "is_synthetic": false,
        "confidence_score": 15,
        "indicators": [
          "The application identity has no known history"
        ]
      },
      "watchlist": {
        "status": "clear",
        "matches": [
          {
            "type": "sanctions",
            "name": "ofac_sdn",
            "confidence_score": 85
          }
        ]
      },
      "updated_at": "2025-10-24T10:35:00Z"
    }
  ],
  "updated_at": "2025-10-24T10:35:00Z"
}

GET

business

{business_id}

verification

{verification_id}

Retrieve business verification

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getpalm.com/v1/business/{business_id}/verification/{verification_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/business/{business_id}/verification/{verification_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.getpalm.com/v1/business/{business_id}/verification/{verification_id} \
  --header 'Authorization: Bearer <token>'

{
  "verification_id": "550e8400-e29b-41d4-a716-446655440000",
  "business_id": "bus_abc123",
  "status": "completed",
  "mode": "live",
  "risk": {
    "level": "low",
    "reasons": [
      "Business status is dissolved",
      "Submitted EIN does not match IRS records",
      "Business registered less than 90 days ago"
    ]
  },
  "match": {},
  "created_at": "2025-10-24T10:30:00Z",
  "reference_id": "biz_12345",
  "associates": [
    {
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "verification_id": "660f9511-f30c-52e5-b827-557766551111",
      "status": "completed",
      "mode": "live",
      "risk": {
        "level": "low",
        "reasons": [
          "Elevated synthetic-fraud score",
          "Identity could not be verified against authoritative records",
          "SSN does not match authoritative records",
          "Multiple core identity fields did not match authoritative records"
        ]
      },
      "match": {},
      "created_at": "2025-10-24T10:30:00Z",
      "reference_id": "user_12345",
      "synthetic": {
        "is_synthetic": false,
        "confidence_score": 15,
        "indicators": [
          "The application identity has no known history"
        ]
      },
      "watchlist": {
        "status": "clear",
        "matches": [
          {
            "type": "sanctions",
            "name": "ofac_sdn",
            "confidence_score": 85
          }
        ]
      },
      "updated_at": "2025-10-24T10:35:00Z"
    }
  ],
  "updated_at": "2025-10-24T10:35:00Z"
}

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

business_id

string

required

verification_id

string

required

Response

200 - application/json

verification_id

string<uuid>

required

Unique verification ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

business_id

string

required

ID of the business entity created or verified

Example:

"bus_abc123"

status

enum<string>

required

Current status of the verification. Branch on this before reading risk or match:

completed — Terminal. Either a confident match (populated match, evaluated risk.level) OR a "no match" verdict (empty match: {}, risk.level: critical with "Business not found" reason).
in_progress — Not yet resolved. risk.level is null; match may be empty or partial — treat both as unset until terminal. Final outcome delivered via business.verification.completed webhook.
failed — Terminal. The verification could not be completed. Safe to retry.

Available options:

pending,

in_progress,

completed,

failed

Example:

"completed"

mode

enum<string>

required

Test/live partition the verification was created under. Determined by the API key used.

Available options:

test,

live

Example:

"live"

risk

object

required

Business risk assessment. Only meaningful when status: completed. See BusinessVerificationRisk.level for the three response shapes (matched / no-match / async-pending).

Show child attributes

match

object

required

Field-level match results against the matched authoritative record. On a matched terminal, every submitted field is present with an explicit result (match, partial_match, no_match, or not_checked) — never omitted. partial_match marks genuine near-matches (name variation/DBA, ±1-day formation date, address containment); formatting differences (abbreviations, ZIP+4) normalize to match. Empty (or near-empty) in two cases: (1) terminal "no match" outcome (status: completed, risk.level: critical) where no record was identified — a submitted ein still reports not_checked; (2) async-pending outcome (status: in_progress) where verification hasn't resolved yet — wait for the webhook. Only fields the partner submitted in the request ever appear.

Show child attributes

created_at

string<date-time>

required

ISO 8601 timestamp of when the verification was created

Example:

"2025-10-24T10:30:00Z"

reference_id

string

Your reference ID (if provided in request)

Example:

"biz_12345"

associates

object[]

Associated people verification results (full KYC results for each associate)

Show child attributes

updated_at

string<date-time>

ISO 8601 timestamp of when the verification was last updated

Example:

"2025-10-24T10:35:00Z"

Verify portfolio business

Retrieve user verification

⌘I

Palm Introduction

API Introduction

Endpoints

Retrieve business verification

Authorizations

Path Parameters

Response