---
title: "Retrieve a PayID"
method: GET
path: "/pay_ids/{id}"
tags: ["PayIDs"]
---

# Retrieve a PayID

`GET /pay_ids/{id}`

Retrieve the details of a specific _PayID_ using the unique id parameter `id`. Only one _PayID_ record is returned.

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- PayId
  - `id` string, uuid
  - `pay_id` string, email
  - `type` 'EMAIL'
  - `status` 'active' | 'activation_failed' | 'pending_activation' | 'deregistered'
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `details` object
    - `pay_id_name` string
    - `owner_legal_name` string
  - `links` object
    - `self` string
    - `virtual_accounts` string

## Other responses

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

---

[API](https://skmtc.net/hellozai/apis/assembly-api.md) · [All operations](https://skmtc.net/hellozai/apis/assembly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellozai/assembly-api/revisions/60b528b2e015/schema)
