Update Applicant information

patch http://localhost:3000/onboarding/applicants/{id}

Update Applicant information

Log in to see full request history

Path Params

id

string

required

Applicant id

Body Params

id

string

required

length ≥ 1

email

string

length ≥ 1

first_name

string

length ≥ 1

middle_name

string

last_name

string

phone

string

length ≥ 1

national_id

string

created_at

string

length ≥ 1

assigned_workflows

array of objects

assigned_workflows

background_checks

array of objects

length ≥ 1

background_checks

title

string

required

length ≥ 1

status

string

required

length ≥ 1

vendor

string

required

length ≥ 1

report_url

string

required

length ≥ 1

documents

array of objects

length ≥ 1

documents

uri

uri

required

title

string

required

description

string

required

revision_date

date

required

type

string

required

size

number

notes

array of objects

length ≥ 1

notes

text

string

required

created_by

string

created_at

string

required

address

object

Applicant address

tags

array of strings

tags

email_verified

boolean

data

array of objects

data

Responses

401

Unauthorized

Language

Credentials

OAuth2


xxxxxxxxxx
13
1
curl --request PATCH \
2
     --url http://localhost:3000/onboarding/applicants/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "documents": [
8
    {
9
      "type": "contract"
10
    }
11
  ]
12
}
13
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json