API Reference

Update a candidate

patch
https://sandbox.gigwage.com/api/v1/background_checks/contractors//candidate

Update a candidate

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

Contractor id

Form Data
addresses[city]
array of strings

The city of the address

addresses[city]
addresses[country]
array of strings

The country of the address as ISO 3166 Alpha-2 two letter code

addresses[country]
addresses[line1]
array of strings

The first line of the address

addresses[line1]
addresses[line2]
array of strings

The second line of the address

addresses[line2]
addresses[state]
array of strings

The state of the address

addresses[state]
addresses[zip_code]
array of strings

The zip code of the address

addresses[zip_code]
string

The primary SMS capable phone number of the candidate. Must be E.164 format, e.g. +14155552671

string

The middle name of the candidate

boolean

True if candidate has no middle name, otherwise False or null

string

The date of birth of the candidate

string

The drivers license number of the candidate

string

The state the candidates drivers license is issued by as ISO 3166-2 two letter code

string

This field you can use to store any identifier that you could track back on your application

string

The gender of the candidate

string

The previous drivers license number of the candidate

string

The state the candidates previous drivers license is issued by as ISO 3166-2 two letter code

Responses

400

Bad Request

Updated over 2 years ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated over 2 years ago