Provide Spousal Info

Provide a spousal profile to a job.

This endpoint provides an existing spousal profile version to a job's supporting item. The profile being provided must belong to the client on the job.

Note

New versions of the profile are not automatically provided to the job; you must explicitly provide the new version. This ensures we can always know what information was provided to an older job, even if the information changes over time.

Endpoint

Method	Url
`POST`	`/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-spousal-info`

Path Parameters

job_id

•

string

required

The unique identifier of the job.

supporting_item_id

•

string

required

The unique identifier of the supporting item. Obtained from the job's checklist input.

Request Body

profile_id

•

string

required

The unique identifier of the spousal profile to provide.

profile_version

•

integer

required

The version number of the spousal profile.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/checklist/550e8400-e29b-41d4-a716-446655440000/provide-spousal-info' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5  "profile_id": "750e8400-e29b-41d4-a716-446655440000",
6  "profile_version": 1
7}'

Response

Returns an empty response.

Errors

403: Access denied - you are not allowed to provide the profile as a supporting item
403: Profile not owned by client - the specified profile is not owned by the client of the job
404: Job not found - the specified job was not found
404: Supporting item not found - the specified supporting item was not found
404: Profile not found - the specified profile or profile version was not found
400: Invalid supporting item type - the supporting item is not of the right type for this action

Next steps

Retrieve a spousal profile for a job

Last updated on December 9, 2024