API Reference

Submit an approved partner identity verification

post
https://api.oysterhr.com/v0.1/engagements//identity_verification/approved

Submits a successful verification result for Partner KYC, allowing you to send relevant information from your identity provider.

Note: Access to the partner KYC process is restricted. Please reach out to [email protected] so we can evaluate your eligibility.

Path Params
string
required

Engagement ID

Body Params
string
required

Unique reference ID for this verification from the partner

string

Optional reason for the approval

user
object
document
object
screening
object
Responses

404

Engagement not found

Updated 3 months ago

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