---
title: "Get a person object"
method: GET
path: "/rest/people/{person_id}"
tags: ["People"]
---

# Get a person object

`GET /rest/people/{person_id}`

## Request

- Base URL: `https://api.dailypay.com`
- URL: `https://api.dailypay.com/rest/people/{person_id}`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://auth.dailypay.com/oauth2/token` scopes: `client:admin`
  - OAuth 2
    - Authorization code: `https://auth.dailypay.com/oauth2/auth`
    - Token URL: `https://auth.dailypay.com/oauth2/token` scopes: `user:read`
- TypeScript: <https://skmtc.dev/dailypay/apis/dailypay-rest-api/docs/rest/people/:person_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns details about a person.

## Response `200`

Returns the person object.

- PersonData
  - `data` PersonResource, required
    - `type` 'people', required
    - `id` string, uuid, required
    - `attributes` PersonAttributes, required: A person is a record of someone known to DailyPay. There will only ever be one person record per human being.
      - `disallow_reason` 'INACTIVE' | 'DELINQUENT' | 'BANNED' | 'null', nullable, required: The statuses and required actions are: - `null` The person has not been disallowed, and is free to use DailyPay. - `INACTIVE` The person has not completed registration or account verification. - `DELINQUENT` The person has an outstanding, unrecoverable balance with DailyPay, and should contact support. - `BANNED` Access has been revoked.
      - `state_of_residence` string: The two-letter abbreviation for the state in which the person resides, if located in the United States. This is used for regulatory compliance purposes.
      - `products` object, required: Products that the person is enrolled in or eligible for. This data is refreshed nightly.
        - `dailypay_card` object, required: The DailyPay Visa®️ Prepaid Card program. A person can be either eligible or enrolled, but not both.
          - `eligible` boolean, required: Whether the person is eligible to enroll in the DailyPay Visa®️ Prepaid Card program.
          - `enrolled` boolean, required: Whether the person is enrolled in the DailyPay Visa®️ Prepaid Card program.
    - `links` PersonLinks, required
      - `self` string, uri, required: The URI for the user

## Other responses

- `400`: Bad Request
- `401`: Invalid authentication credentials
- `403`: Not authorized to perform this operation
- `404`: Resource was not found
- `500`: Unexpected error occured

---

[API](https://skmtc.dev/dailypay/apis/dailypay-rest-api.md) - [All operations](https://skmtc.dev/dailypay/apis/dailypay-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dailypay/apis/dailypay-rest-api/revisions/24f4c159e842?raw)