Update candidate resource

put

https://api.accuratebackground.com/v3/candidate/{id}

Updates an existing candidate created via Candidate Creation.

Warning: This does not update the candidate details on orders previously submitted
via Order Creation. It will however apply to any
orders submitted after the update.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
This endpoint does not work in Sandbox.
This endpoint does not work with the Sandbox credentials

Path Params

string

required

Candidate ID

Body Params

firstName

string

First name of candidate.

lastName

string

middleName

string

Last name of candidate.

suffix

string

dateOfBirth

date

Required only for Express workflow.

ssn

string

Social Security Number.

Required only for Express workflow.

string

Some workflows require contacting the candidate via email.

phone

string

Required only for Express workflow.

address

string

Candidate’s street address.

city

string

City candidate resides in.

region

string

State candidate resides in.

country

string

Country code of candidate. Accurate Background uses ISO 3166 Country Codes.

postalCode

string

Candidate’s postal code.

governmentId

object

aliases

array of objects

aliases

educations

array of objects

educations

prevEmployed

boolean

Required for EMP product only in Express workflow, Indicates if candidate has previous employment history. prevEmployed will default as “false” when no value is provided. Only required if employment information is entered.

employments

array of objects

employments

licenses

array of objects

licenses

convicted

boolean

convictions

array of objects

convictions

references

array of objects

references

addressHistory

array of objects

addressHistory

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

This endpoint does not work in Sandbox.

200Success Response

400Bad Request

401Unauthorized Response

500Internal Server error