API Reference

Simulate the start of the enrollment process for an employee

post
https://publicapi.wagestream.io/pushapi-prod/testenrollments

Only for use when testing, not available on production. This endpoints enables you to take an employee which you've previously uploaded and trigger the start of the enrollment process for, this enables you to test the end to end process for enrollments

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
employee_ids
array of strings
required

Comma delimited list of employee_id's to trigger the enrollment process with

employee_ids*
boolean | null

This setting is only useful if you are implementing the Enterprise or Instant Verification enrolment flows. If you are using the Standard Enrolment flow, then this parameter is redundant.

Including and setting pending to true simulates an employee registering on the app, and them then
accepting terms and conditions. At this stage they are in Pending

After polling for pending enrollments, and seeing an employee requesting to enroll - you would
submit, via POSTing to the employees end point the remaining information required to complete
their enrolment.

Responses
200

Success

403

Forbidden - API key invalid

Updated 11 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 11 months ago