logo

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.

Get a job object

Returns details about a person's employment.

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

Unique ID of the job

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 job object.

Response Schema: application/vnd.api+json
required
object (JobResource)

A job describes the financial relationship between a person and an organization.

type
required
string
Value: "jobs"
id
required
string <uuid>
Example: "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
required
object (JobAttributes)
object

Holds unique identifiers for the employee or job defined by external organizations.

first_name
string

The first name of the person as it is listed in their employee profile.

Example: "Edith"
last_name
string

The last name of the person as it is listed in their employee profile.

Example: "Clarke"
activation_status
string

Activation is the process of verifying that data is available for a Job, and that a person has verified their identity as the Person associated with the Job. Only paychecks from Jobs with activated status will contribute to an earnings balance account.

To deactivate a job, update activation_status to DEACTIVATED.

Enum Value Description
DEACTIVATED

Job is no longer activated for DailyPay.

DEACTIVATION_PENDING

Job is no longer activated for DailyPay, and deactivation is pending.

ACTIVATION_REQUIRED

Job data is available but a person has not activated this Job for a DailyPay account.

ACTIVATION_UNDER_REVIEW

Job data is available but a manual review step is underway.

ACTIVATED

Job data is available and ready for use with DailyPay. A remainder pay account may still need to be configured by setting default_paycheck_destinations.

required
object
title
string or null
Example: "Computer"
department
string or null
Example: null
location
string
Example: "New York, New York"
direct_deposit_status
required
string
  • SETUP_REQUIRED Direct deposit is not set up for this Job. Update this resource's relationships to set up direct deposit.
  • SETUP_PENDING A system action is still pending.
  • SETUP_COMPLETE Direct deposit is set up for this Job.
Enum: "SETUP_REQUIRED" "SETUP_PENDING" "SETUP_COMPLETE"
Example: "SETUP_COMPLETE"
required
object (JobLinks)
self
required
string <uri> (JobLink)
required
object (JobRelationships)

The relationships between the job and other resources, including the accounts to which paychecks from this job are deposited.

required
object (PersonRelationshipReadOnly)
required
object (OrganizationRelationship)
object (AccountRelationship)

The DEPOSITORY account to which paychecks from this job will attempt to be deposited.

object (AccountRelationship)

The CARD account to which paychecks from this job will attempt to be deposited, if the DEPOSITORY account fails.

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/jobs/{job_id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    • "type": "jobs",
    • "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f",
    • "attributes": {
      • "external_identifiers": {
        • "primary_identifier": "0123456789"
        },
      • "first_name": "Edith",
      • "last_name": "Clarke",
      • "activation_status": "DEACTIVATED",
      • "wage_rate": {
        • "amount": 2500,
        • "currency": "USD",
        • "frequency": "HOURLY"
        },
      • "title": "Computer",
      • "department": null,
      • "location": "New York, New York",
      • "direct_deposit_status": "SETUP_COMPLETE"
      },
    • "links": {},
    • "relationships": {
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
          }
        },
      • "organization": {
        • "data": {
          • "type": "organizations",
          • "id": "f0b30634-108c-439c-a8c1-c6a91197f022"
          }
        },
      • "direct_deposit_default_depository": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "direct_deposit_default_card": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        }
      }
    }
}
Update paycheck settings or deactivate a job
Update this job to set where pay should be deposited for paychecks related to this job,  or deactivate on-demand pay for this job. 
Returns the job object if the update succeeded. Returns an error if update parameters are invalid.


Securityoauth_user_token 
Request 
path Parameters
job_id
required
string <uuid> 
Unique ID of the job


 
 Example:  e9d84b0d-92ba-43c9-93bf-7c993313fa6f
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
A job describes the financial relationship between a person and an organization.


 
type
required
string
 
 Value:  "jobs"
id
required
string <uuid> 
 
 Example:  "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
object (JobAttributes) 
 
activation_status
string
Activation is the process of verifying that data is available for a Job,  and that a person has verified their identity as the Person associated with the Job. Only paychecks from Jobs with activated status will contribute to an earnings balance account.


To deactivate a job, update activation_status to DEACTIVATED.


 Enum Value Description
DEACTIVATED
Job is no longer activated for DailyPay.


DEACTIVATION_PENDING
Job is no longer activated for DailyPay, and deactivation is pending.


ACTIVATION_REQUIRED
Job data is available but a person has not activated this Job for a DailyPay account.


ACTIVATION_UNDER_REVIEW
Job data is available but a manual review step is underway.


ACTIVATED
Job data is available and ready for use with DailyPay. A remainder pay account may still need to be configured by setting default_paycheck_destinations.


 
object (JobRelationships) 
The relationships between the job and other resources, including the accounts to which paychecks from this job are deposited.


 
object (AccountRelationship) 
The DEPOSITORY account to which paychecks from this job will attempt to be deposited.


 
object (AccountRelationship) 
The CARD account to which paychecks from this job will attempt to be deposited, if the DEPOSITORY account fails.


 
Responses 
200
Returns the updated Job object


Response Schema: application/vnd.api+json
required
object (JobResource) 
A job describes the financial relationship between a person and an organization.


 
type
required
string
 
 Value:  "jobs"
id
required
string <uuid> 
 
 Example:  "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
required
object (JobAttributes) 
 
object
Holds unique identifiers for the employee or job defined by external organizations.


 
first_name
string
The first name of the person as it is listed in their employee profile.


 
 Example:  "Edith"
last_name
string
The last name of the person as it is listed in their employee profile.


 
 Example:  "Clarke"
activation_status
string
Activation is the process of verifying that data is available for a Job,  and that a person has verified their identity as the Person associated with the Job. Only paychecks from Jobs with activated status will contribute to an earnings balance account.


To deactivate a job, update activation_status to DEACTIVATED.


 Enum Value Description
DEACTIVATED
Job is no longer activated for DailyPay.


DEACTIVATION_PENDING
Job is no longer activated for DailyPay, and deactivation is pending.


ACTIVATION_REQUIRED
Job data is available but a person has not activated this Job for a DailyPay account.


ACTIVATION_UNDER_REVIEW
Job data is available but a manual review step is underway.


ACTIVATED
Job data is available and ready for use with DailyPay. A remainder pay account may still need to be configured by setting default_paycheck_destinations.


 
required
object
 
title
string or null
 
 Example:  "Computer"
department
string or null
 
 Example:  null
location
string
 
 Example:  "New York, New York"
direct_deposit_status
required
string
    

  • SETUP_REQUIRED Direct deposit is not set up for this Job. Update this resource's relationships to set up direct deposit.
    • 

  • SETUP_PENDING A system action is still pending.
    • 

  • SETUP_COMPLETE Direct deposit is set up for this Job.
    • 



 Enum: "SETUP_REQUIRED" "SETUP_PENDING" "SETUP_COMPLETE"  
 Example:  "SETUP_COMPLETE"
required
object (JobLinks) 
 
self
required
string <uri>  (JobLink) 
 
required
object (JobRelationships) 
The relationships between the job and other resources, including the accounts to which paychecks from this job are deposited.


 
required
object (PersonRelationshipReadOnly) 
 
required
object (OrganizationRelationship) 
 
object (AccountRelationship) 
The DEPOSITORY account to which paychecks from this job will attempt to be deposited.


 
object (AccountRelationship) 
The CARD account to which paychecks from this job will attempt to be deposited, if the DEPOSITORY account fails.


 
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/jobs/{job_id}
Request samples 
application/vnd.api+json
{
  • "data": {
    • "type": "jobs",
    • "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f",
    • "attributes": {
      • "activation_status": "DEACTIVATED"
      },
    • "relationships": {
      • "direct_deposit_default_depository": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "direct_deposit_default_card": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        }
      }
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    • "type": "jobs",
    • "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f",
    • "attributes": {
      • "external_identifiers": {
        • "primary_identifier": "0123456789"
        },
      • "first_name": "Edith",
      • "last_name": "Clarke",
      • "activation_status": "DEACTIVATED",
      • "wage_rate": {
        • "amount": 2500,
        • "currency": "USD",
        • "frequency": "HOURLY"
        },
      • "title": "Computer",
      • "department": null,
      • "location": "New York, New York",
      • "direct_deposit_status": "SETUP_COMPLETE"
      },
    • "links": {},
    • "relationships": {
      • "person": {
        • "data": {
          • "type": "people",
          • "id": "3fa8f641-5717-4562-b3fc-2c963f66afa6"
          }
        },
      • "organization": {
        • "data": {
          • "type": "organizations",
          • "id": "f0b30634-108c-439c-a8c1-c6a91197f022"
          }
        },
      • "direct_deposit_default_depository": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        },
      • "direct_deposit_default_card": {
        • "data": {
          • "type": "accounts",
          • "id": "2bc7d781-3247-46f6-b60f-4090d214936a"
          }
        }
      }
    }
}
Get a list of job objects
Returns a collection of job objects. This object represents a person's employment details.
See Filtering Jobs for a description of filterable fields.


Securityoauth_user_token or oauth_client_credentials_token 
Request 
query Parameters
filter[first_name]
string
Limit the results to documents with a matching first name, case insensitive.


 
filter[last_name]
string
Limit the results to documents with a matching last name, case insensitive.


 
filter[external_identifiers.primary_identifier]
string
Limit the results to documents with an external identifier matching exactly at the specified key.


 
filter[external_identifiers.employee_id]
string
Not yet supported Limit the results to documents with an external identifier matching exactly at the specified key.


 
filter[external_identifiers.group]
string
Not yet supported Limit the results to documents with an external identifier matching exactly at the specified key.


 
filter[person.id]
string
Limit the results to documents related to a specific person


 
filter[organization.id]
string
Not yet supported Limit the results to documents related to a specific organization


 
filter
string
 Deprecated 
 
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 a list of job objects.


Response Schema: application/vnd.api+json
required
Array of objects (JobResource) 
 
 Array 
type
required
string
 
 Value:  "jobs"
id
required
string <uuid> 
 
 Example:  "e9d84b0d-92ba-43c9-93bf-7c993313fa6f"
required
object (JobAttributes) 
 
required
object (JobLinks) 
 
required
object (JobRelationships) 
The relationships between the job and other resources, including the accounts to which paychecks from this job are deposited.


 
400
Bad Request


401
Invalid authentication credentials


403
Not authorized to perform this operation


500
Unexpected error occured


get/rest/jobs
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    • {
      • "type": "jobs",
      • "id": "e9d84b0d-92ba-43c9-93bf-7c993313fa6f",
      • "attributes": {
        • "external_identifiers": {
          • "primary_identifier": "0123456789"
          },
        • "first_name": "Edith",
        • "last_name": "Clarke",
        • "activation_status": "DEACTIVATED",
        • "wage_rate": {
          • "amount": 2500,
          • "currency": "USD",
          • "frequency": "HOURLY"
          },
        • "title": "Computer",
        • "department": null,
        • "location": "New York, New York",
        • "direct_deposit_status": "SETUP_COMPLETE"
        },
      • "links": {},
      • "relationships": {
        • "person": {
          • "data": {
            }
          },
        • "organization": {
          • "data": {
            }
          },
        • "direct_deposit_default_depository": {
          • "data": {
            }
          },
        • "direct_deposit_default_card": {
          • "data": {
            }
          }
        }
      }
    ]
}
➔ Next to Accounts