logo

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.

Get a person object

Returns details about a person.

Securityoauth_user_token or oauth_client_credentials_token
Request
path Parameters
person_id
required
string <uuid>

Unique ID of the person

Example: aa860051-c411-4709-9685-c1b716df611b
header Parameters
DailyPay-API-Version
integer
Default: 3

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

Accept
string
Default: application/vnd.api+json

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.

Enum: "application/vnd.api+json" "*/*"
Responses
200

Returns the person object.

Response Schema: application/vnd.api+json
required
object (PersonResource)
type
required
string
Value: "people"
id
required
string <uuid>
Example: "aa860051-c411-4709-9685-c1b716df611b"
required
object (PersonAttributes)

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

disallow_reason
required
string or null

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
state_of_residence
string <= 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"
required
object (PersonLinks)
self
required
string <uri> (PersonLink)

The URI for the user

400

Bad Request

401

Invalid authentication credentials

403

Not authorized to perform this operation

404

Resource was not found

500

Unexpected error occured

get/rest/people/{person_id}
Request samples 
Response samples 
application/vnd.api+json
{}
Update a person
Update a person object.


Securityoauth_user_token 
Request 
path Parameters
person_id
required
string <uuid> 
Unique ID of the person


 
 Example:  aa860051-c411-4709-9685-c1b716df611b
header Parameters
DailyPay-API-Version
integer
 Default:  3
The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used.


 
Accept
string
 Default:  application/vnd.api+json
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.


 Enum: "application/vnd.api+json" "*/*"  
Request Body schema: application/vnd.api+json
required
required
object (PersonResource) 
 
type
required
string
 
 Value:  "people"
id
required
string <uuid> 
 
 Example:  "aa860051-c411-4709-9685-c1b716df611b"
required
object (PersonAttributes) 
A person is a record of someone known to DailyPay. There will only ever be one person record per human being.


 
state_of_residence
string  <= 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"
Responses 
200
Returns the person object.


Response Schema: application/vnd.api+json
required
object (PersonResource) 
 
type
required
string
 
 Value:  "people"
id
required
string <uuid> 
 
 Example:  "aa860051-c411-4709-9685-c1b716df611b"
required
object (PersonAttributes) 
A person is a record of someone known to DailyPay. There will only ever be one person record per human being.


 
disallow_reason
required
string or null
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
state_of_residence
string  <= 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"
required
object (PersonLinks) 
 
self
required
string <uri>  (PersonLink) 
The URI for the user


 
400
Bad Request


401
Invalid authentication credentials


403
Not authorized to perform this operation


404
Resource was not found


500
Unexpected error occured


patch/rest/people/{person_id}
Request samples 
application/vnd.api+json
{
  • "data": {
    • "type": "people",
    • "id": "aa860051-c411-4709-9685-c1b716df611b",
    • "attributes": {
      • "state_of_residence": "NY"
      }
    }
}
Response samples 
application/vnd.api+json
{}
➔ Next to Cards