---
title: "Retrieve a Payer"
method: GET
path: "/payers/{id}"
tags: ["Payers"]
---

# Retrieve a Payer

`GET /payers/{id}`

## Path parameters

- `id` string, uuid, required

## Headers

- `Trace-Id` string
- `End-User-Agent` string
- `End-User-Ip` string
- `End-User-OS` string
- `End-User-Device-Id` string
- `End-User-Device-Manufacturer` string
- `End-User-Device-Model` string

## Response `200`

Payer retrieved successfully.

- Payer
  - `id` string, uuid
  - `externalId` string — Consumer defined ID that will be attached to this resource
  - `businessName` string
  - `contact` union
    - object
      - `firstName` string
      - `lastName` string
      - `email` string, required
      - `phone` string
    - object
      - `firstName` string
      - `lastName` string
      - `email` string
      - `phone` string, required
  - `businessAddress` Address
    - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name).
    - `line2` string — Address line 2 (e.g., apartment, suite, unit, or building).
    - `city` string, required — City, district, suburb, town, or village.
    - `state` string, required — State, county, province, or region.
    - `postalCode` string, required — ZIP or postal code.
    - `country` string, required — Two-letter country code (ISO 3166-1 alpha-2).
  - `createdAt` string, date-time
  - `status` 'ACTIVE' | 'INACTIVE' | 'UNKNOWN' — The status of an object
  - `hasIdentityDocuments` boolean — Indicates whether the payer has saved identity documents
  - `identityDocuments` IdentityDocumentResponse[]
    - `type` 'US_TIN' | 'US_EIN' | 'US_SSN' | 'PASSPORT_NUMBER' | 'ALIEN_REGISTRATION_NUMBER'
    - `id` string, uuid
  - `metadata` PayerMetadata — Additional Payer information to support operational requirements
    - `accountSettings` AccountSettingsMetadata
      - `emailConfirmation` boolean — Whether or not the associated entity has confirmed its email.
      - `phoneConfirmation` boolean — Whether or not the associated entity has confirmed its phone number.
      - `singleSignOn` boolean — Whether or not the associated entity uses single-sign-on.
      - `singleSignOnType` string — The single-sign-on service the associated entity uses.
      - `twoFactor` boolean — Whether or not the associated entity uses two-factor authentication.
      - `multiFactor` boolean — Whether or not the associated entity uses multi-factor authentication.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/plastiq/apis/plastiq-public-api.md) · [All operations](https://skmtc.dev/plastiq/apis/plastiq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/plastiq/plastiq-public-api/revisions/cfd776dd9ac5/schema)