Skip to content
REST API Reference/
/
Get a person object

DailyPay Public Rest API (3.0.0-beta01)

Embed DailyPay and On Demand Pay features into your application.

Download OpenAPI description
index.json
index.yaml
Overview
URL

https://developer.dailypay.com

License

MIT

Languages
Servers
Mock server

https://developer.dailypay.com/_mock/developer-resources/documentation/

DailyPay REST API server

https://api.{environment}.com/

API Status

Please subscribe to the DailyPay Status Page for the current status of the DailyPay Public REST API.

Environments

In general, DailyPay APIs have two environments per API and follow the naming structure of api.dailypay.com for the Production environment and api.dailypayuat.com for the UAT environment.

DailyPay APIs and their respective environments

API NameProduction URLUAT URL
DailyPay Public REST APIhttps://api.dailypay.comhttps://api.dailypayuat.com
Data Exchange APIhttps://api.dailypay.comhttps://api.dailypayuat.com
Payments APIhttps://payments-api.dailypay.comhttps://payments-api.dailypayuat.com

Key differences between the Production and UAT environments:

EnvironmentPurposeAccessData
ProductionLive environment for processing production API TrafficRestricted access for authorized clients and users onlyReal production data exchanges including money movement
UATStaging environment for developers to test new features, updates, and changesLess restricted access for both developers and testersTest data and exchanges without money movement

Functionality Differences

FunctionUATProduction
Testing user data without PII✓
Ability to mock transfer of funds✓
Ability to integrate with custom code✓✓
Access to real-world transactions like ACH Deposits✓
Live customer data✓
Live transactions moving real funds✓

Filtering

Efficiently retrieve DailyPay REST API resources with filtering queries by specifying query parameters in the request URL. This guide outlines how to build your queries.

The request URL for a filtered query is structured as follows:

https://api.dailypay.com/{endpoint}?filter[{field}]={value}

Each filter is a standard URL query parameter key-value pair. Filter parameters follow the jsonapi specification of a query parameter family, where the parameter key is the base name filter followed by a square-bracketed ([]) field name.

  • The {endpoint} is the resource you want to filter, such as organizations, transfers, or paychecks.
  • A {field} is the attribute of a resource you want to filter by, such as a person's employee ID or a transfer's status.
  • A {value} is any value that could be a valid payload for the attribute, such as "DailyPay" for an organization name, or "PROCESSING" for a transfer status.

URL Encoding

The symbols used in DailyPay's filter strings MUST be urlencoded.

For example, a curl would look like:

curl  \
  --get 'https://api.dailypayuat.com/rest/jobs' \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --data-urlencode "filter[external_identifiers.primary_identifier]=040919553433" \
  --include

When using one of our published SDKs, you do not have to transform or urlencode filter keys.

Examples

Exact Match

Filter for a paycheck with the status "IN_TRANSIT".

GET https://api.dailypay.com/paychecks?filter[status]=IN_TRANSIT

Multiple Filters: ALL

Use multiple query parameters across different fields filter[{field}]={value} at the same time to fine tune the response. Each result will match all filters.

GET https://api.dailypay.com/paychecks?filter[job.id]=12345&filter[status]=PROCESSING

Versioning

  • Each API at DailyPay adheres to semver standards for versioning, represented as MAJOR.MINOR.PATCH:

    • The MAJOR version is incremented for breaking changes.
    • The MINOR version is incremented for backwards compatible changes.
    • The PATCH version is incremented for backwards compatible bug fixes.

  • DailyPay will issue a new major API version when a breaking change occurs.

  • To avoid breaking your code, developers are responsible for updating their API calls to interact with new versions of the DailyPay APIs.

  • Communication about API changes will be in the changelogs for the APIs or available from your DailyPay representatives.

DailyPay views the following items as backwards compatible non-breaking changes:

  • New resources
  • New optional query parameters
  • New optional body properties on PATCH, POST, PUT
  • New properties on existing API responses
  • Property order changes on existing API responses
  • Changes to the content, length, or format of error messages and other human-readable strings

Selecting the API Version

Your API version controls the API behavior, properties in responses, available parameters in requests, and so on.

If you want to use API version v3 of the DailyPay Public REST API, specify the URL https://api.dailypay.com/rest or https://api.dailypayuat.com/rest.

Accounts

The accounts endpoint provides comprehensive information about money accounts. You can retrieve account details, including the account's unique ID, a link to the account holder, type, subtype, verification status, balance details, transfer capabilities, and user-specific information such as names, routing numbers, and partial account numbers.

Functionality: Access detailed user account information, verify account balances, view transfer capabilities, and access user-specific details associated with each account.

Operations

Health

The health endpoint provides a simple health check for the API.

Functionality: Check the status of the API to ensure it is functioning correctly.

Operations

Jobs

The jobs endpoint provides access to comprehensive information about a person's employment. It enables you to retrieve details about individual jobs, including information about the organization they work for, status, wage rate, job title, location, paycheck settings, and related links to associated accounts.

Operations

Organizations

The organizations endpoint provides details about a business entity, such as an employer, or a group of people, such as a division.

The response includes the organization name and ID which can be used to make subsequent endpoint calls related to the organization and its employees.

Operations

Paychecks

The paychecks endpoint provides detailed information about paychecks. You can retrieve individual paycheck details, including the person and job associated with the paycheck, its status, pay period, expected deposit date, total debited amount, withholdings, earnings, and currency.

Functionality: Retrieve specific paycheck details, including payee and job information, and monitor the status and financial details of each paycheck.

Operations

People

The people endpoint allows you to see information related to who owns resources such as jobs and accounts.

Functionality: Retrieve limited details about a person, including their name, global status, and state of residence.

Operations

Get a person object

Request

Returns details about a person.

Security
oauth_client_credentials_token or oauth_user_token
Path
person_idstring(uuid)required

Unique ID of the person

Example: aa860051-c411-4709-9685-c1b716df611b
Headers
DailyPay-API-Versioninteger

The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

Default 3
Acceptstring

The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format. For more details, see https://jsonapi.org.

Default application/vnd.api+json
Enum"application/vnd.api+json""*/*"
import { SDK } from "@dailypay/dailypay";

const sdk = new SDK({
  version: 3,
  security: {
    oauthClientCredentialsToken: {
      clientID: "<YOUR_CLIENT_ID_HERE>",
      clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
      tokenURL: "<YOUR_TOKEN_URL_HERE>",
    },
  },
});

async function run() {
  const result = await sdk.people.read({
    personId: "aa860051-c411-4709-9685-c1b716df611b",
  });

  console.log(result);
}

run();

Responses

Returns the person object.

Bodyapplication/vnd.api+json
dataobject(PersonResource)required
data.​typestringrequired
Value "people"
data.​idstring(uuid)required
Example: "aa860051-c411-4709-9685-c1b716df611b"
data.​attributesobject(PersonAttributes)required

A person is a record of someone known to DailyPay. There will only ever be one person record per human being.

data.​attributes.​disallow_reasonstring or nullread-onlyrequired

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.
Enum"INACTIVE""DELINQUENT""BANNED"null
Example: null
data.​attributes.​state_of_residencestring<= 2 characters

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.

Example: "NY"
data.​attributes.​productsobjectread-onlyrequired

Products that the person is enrolled in or eligible for.

data.​attributes.​products.​dailypay_cardobjectrequired

The DailyPay Visa®️ Prepaid Card program.

data.​attributes.​products.​dailypay_card.​eligiblebooleanrequired

Whether the person is eligible to enroll in the DailyPay Visa®️ Prepaid Card program.

Example: true
data.​attributes.​products.​dailypay_card.​enrolledbooleanrequired

Whether the person is enrolled in the DailyPay Visa®️ Prepaid Card program.

Example: false
data.​linksobject(PersonLinks)read-onlyrequired
data.​links.​selfstring(uri)(PersonLink)read-onlyrequired

The URI for the user

Response
application/vnd.api+json
{
  "data": {
    "type": "people",
    "id": "aa860051-c411-4709-9685-c1b716df611b",
    "attributes": {
      "disallow_reason": null,
      "state_of_residence": "NY",
      "products": { … }
    },
    "links": {
      "self": "https://api.dailypay.com/rest/people/aa860051-c411-4709-9685-c1b716df611b"
    }
  }
}

Update a person

Request

Update a person object.

Security
oauth_user_token
Path
person_idstring(uuid)required

Unique ID of the person

Example: aa860051-c411-4709-9685-c1b716df611b
Headers
DailyPay-API-Versioninteger

The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.

Default 3
Acceptstring

The media type of the requested payload. This should be set to application/vnd.api+json to signify your client can receive responses in the JSON:API format. For more details, see https://jsonapi.org.

Default application/vnd.api+json
Enum"application/vnd.api+json""*/*"
Bodyapplication/vnd.api+jsonrequired
dataobject(PersonResource)required
data.​typestringrequired
Value "people"
data.​idstring(uuid)required
Example: "aa860051-c411-4709-9685-c1b716df611b"
data.​attributesobject(PersonAttributes)required

A person is a record of someone known to DailyPay. There will only ever be one person record per human being.

data.​attributes.​state_of_residencestring<= 2 characters

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.

Example: "NY"
import { SDK } from "@dailypay/dailypay";

const sdk = new SDK({
  version: 3,
  security: {
    oauthClientCredentialsToken: {
      clientID: "<YOUR_CLIENT_ID_HERE>",
      clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
      tokenURL: "<YOUR_TOKEN_URL_HERE>",
    },
  },
});

async function run() {
  const result = await sdk.people.update({
    personId: "aa860051-c411-4709-9685-c1b716df611b",
    personData: {
      data: {
        type: "people",
        id: "aa860051-c411-4709-9685-c1b716df611b",
        attributes: {
          stateOfResidence: "NY",
        },
      },
    },
  });

  console.log(result);
}

run();

Responses

Returns the person object.

Bodyapplication/vnd.api+json
dataobject(PersonResource)required
data.​typestringrequired
Value "people"
data.​idstring(uuid)required
Example: "aa860051-c411-4709-9685-c1b716df611b"
data.​attributesobject(PersonAttributes)required

A person is a record of someone known to DailyPay. There will only ever be one person record per human being.

data.​attributes.​disallow_reasonstring or nullread-onlyrequired

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.
Enum"INACTIVE""DELINQUENT""BANNED"null
Example: null
data.​attributes.​state_of_residencestring<= 2 characters

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.

Example: "NY"
data.​attributes.​productsobjectread-onlyrequired

Products that the person is enrolled in or eligible for.

data.​attributes.​products.​dailypay_cardobjectrequired

The DailyPay Visa®️ Prepaid Card program.

data.​attributes.​products.​dailypay_card.​eligiblebooleanrequired

Whether the person is eligible to enroll in the DailyPay Visa®️ Prepaid Card program.

Example: true
data.​attributes.​products.​dailypay_card.​enrolledbooleanrequired

Whether the person is enrolled in the DailyPay Visa®️ Prepaid Card program.

Example: false
data.​linksobject(PersonLinks)read-onlyrequired
data.​links.​selfstring(uri)(PersonLink)read-onlyrequired

The URI for the user

Response
application/vnd.api+json
{
  "data": {
    "type": "people",
    "id": "aa860051-c411-4709-9685-c1b716df611b",
    "attributes": {
      "disallow_reason": null,
      "state_of_residence": "NY",
      "products": { … }
    },
    "links": {
      "self": "https://api.dailypay.com/rest/people/aa860051-c411-4709-9685-c1b716df611b"
    }
  }
}

Transfers

The transfers endpoint allows you to initiate and track money movement. You can access transfer details, including the transfer's unique ID, amount, currency, status, schedule, submission and resolution times, fees, and related links to the involved parties.

Functionality Retrieve transfer information, monitor transfer statuses, view transfer schedules, and access relevant links for the source, destination, and origin of the transfer.

Important - Account origin: a user initiated movement of money from one account to another - Paycheck origin: an automatic (system-generated) movement of money as part of payroll

Operations

Card Tokenization

Securely tokenize personal cards for use in the accounts API.

Operations
© 2025 DailyPay LLC. All rights reserved.