API Reference

Create a document request for an engagement

post
https://api.oysterhr.com/v0.1/engagements//document_requests/

Creates a self-service document request for an engagement with a given engagement ID and document request type. startDate, endDate, destinationCountry, and passportNumber are required when document type is employment_verification_visa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Engagement ID

string
required

Document request type, one of: employment_verification_visa, employment_verification_mortgage, past_employment_verification_with_salary.

Body Params
date
date
string
length between 2 and 2
string
length ≥ 1
Responses

Updated 7 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago