Provide Dependent Info
Provide a dependent profile to a job.
This endpoint either adds a dependent profile to a job's supporting item or updates which version of an already-provided profile is being referenced.
If the specified profile has not yet been provided to this supporting item, it will be added. If the profile was already provided, this endpoint will update which version of that profile is being referenced.
The profile being provided must belong to the client on the job.
New versions of a profile are not automatically provided to jobs that reference that profile; you must explicitly provide the new version using this endpoint. This ensures we can always know what information was provided to an older job, even if the information changes over time.
Multiple dependent profiles can be provided to a job; simply make a request for each profile you want to provide.
Endpoint
| Method | Url |
|---|---|
POST | /v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-dependent-info |
Path Parameters
The unique identifier of the job.
The unique identifier of the supporting item. Obtained from the job's checklist input.
Request Body
The unique identifier of the dependent profile to provide.
The version number of the dependent profile.
Sample Request
Copied1curl -X POST 'https://api.worklayer.com/v1.0/jobs/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/checklist/550e8400-e29b-41d4-a716-446655440000/provide-dependent-info' \2-H 'Authorization: Bearer {token}' \3-H 'Content-Type: application/json' \4-d '{5 "profile_id": "e7b513b9-d795-4475-9382-96710ca61622",6 "profile_version": 17}'
Response
Returns an empty response.
Errors
403: Access denied - you are not allowed to provide the profile as a supporting item403: Profile not owned by client - the specified profile is not owned by the client of the job404: Job not found - the specified job was not found404: Supporting item not found - the specified supporting item was not found404: Profile not found - the specified profile or profile version was not found400: Invalid supporting item type - the supporting item is not of the right type for this action