application-profile

Create or Update Application Profile

Create or update the authenticated user's application profile. All fields are optional; only provided fields are updated.

put/application-profile

Request

  • Base URL: https://api.aiapplyd.com/api/v1
  • URL: https://api.aiapplyd.com/api/v1/application-profile
  • Auth: HTTP bearer

Request body

phonestring nullable

Phone number

addressLine1string nullable

Address line 1

addressLine2string nullable

Address line 2

citystring nullable

City

statestring nullable

State or province

zipCodestring nullable

ZIP or postal code

countrystring nullable

Country

linkedinUrlstring uri nullable

LinkedIn profile URL

portfolioUrlstring uri nullable

Portfolio website URL

githubUrlstring uri nullable

GitHub profile URL

currentEmployerstring nullable

Current employer / company. Helps tailor recommendations; unlocks team analytics if the company onboards.

dateOfBirthstring nullable

Date of birth (ISO 8601 date string)

workAuthorization'us_citizen' | 'permanent_resident' | 'visa_holder' | 'require_sponsorship' | 'other' | 'null' nullable

Work authorization status

willingToRelocateboolean

Willing to relocate for a job

relocationLocationsstring[] nullable

Preferred relocation locations as "City, Country" or "Country" (max per-entry stripping of middle admin segments on ingest).

salaryCurrency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'inr' | 'null' nullable

Salary currency

availableStartDatestring nullable

Earliest available start date (ISO 8601 date string)

noticePeriod'immediately' | 'two_weeks' | 'one_month' | 'two_months' | 'three_months' | 'flexible' | 'null' nullable

Notice period before starting new position

personalNarrativestring nullable

Free-form narrative about gaps / transitions / short stints. Drives interview-prep red-flag question generation (F8).

travelWillingness'none' | 'up_to_25' | 'up_to_50' | 'up_to_75' | 'up_to_100' | 'null' nullable

Willingness to travel for work

securityClearance'none' | 'confidential' | 'secret' | 'top_secret' | 'ts_sci' | 'prefer_not_to_say' | 'null' nullable

Security clearance level

restrictiveCovenantStatus'yes' | 'no' | 'prefer_not_to_say' | 'null' nullable

Currently subject to a non-compete / non-solicit / restrictive covenant with a former employer

criminalRecordStatus'yes' | 'no' | 'prefer_not_to_say' | 'null' nullable

Has a criminal conviction they are legally required to disclose

backgroundCheckConsent'yes' | 'no' | 'prefer_not_to_say' | 'null' nullable

Consents to a background / reference / credit check or drug screen where the role requires one

relatedToEmployeeStatus'yes' | 'no' | 'prefer_not_to_say' | 'null' nullable

Has a family member or close personal relationship with an employee of a company they apply to. Global, not per-employer: only a "no" is committable on a form.

exportControlUsPerson'yes' | 'no' | 'prefer_not_to_say' | 'null' nullable

Is a U.S. person for export-control (ITAR / EAR) purposes. The only declaration whose "yes" is the permissive answer.

highestEducation'high_school' | 'associate' | 'bachelor' | 'master' | 'doctorate' | 'any' | 'null' nullable

Highest education level completed

yearsOfExperienceinteger nullable

Total years of professional experience

veteranStatus'not_a_veteran' | 'veteran' | 'disabled_veteran' | 'recently_separated_veteran' | 'active_duty_wartime_veteran' | 'armed_forces_service_medal_veteran' | 'prefer_not_to_say' | 'null' nullable

Veteran status for EEO forms

disabilityStatus'yes' | 'no' | 'prefer_not_to_say' | 'null' nullable

Disability status for EEO forms

gender'male' | 'female' | 'non_binary' | 'prefer_not_to_say' | 'other' | 'null' nullable

Gender for EEO forms

ethnicity'american_indian_or_alaska_native' | 'asian' | 'black_or_african_american' | 'hispanic_or_latino' | 'native_hawaiian_or_pacific_islander' | 'white' | 'two_or_more_races' | 'prefer_not_to_say' | 'other' | 'null' nullable

Ethnicity for EEO forms

sexualOrientation'heterosexual' | 'gay_or_lesbian' | 'bisexual' | 'prefer_not_to_say' | 'other' | 'null' nullable

Sexual orientation for EEO forms

pronounsstring nullable

Preferred pronouns, self-described free text

Example request

{
  "phone": "+1-555-123-4567",
  "addressLine1": "123 Main St",
  "addressLine2": "Apt 4B",
  "city": "San Francisco",
  "state": "CA",
  "zipCode": "94105",
  "country": "US",
  "linkedinUrl": "https://linkedin.com/in/johndoe",
  "portfolioUrl": "https://johndoe.dev",
  "githubUrl": "https://github.com/johndoe",
  "currentEmployer": "Acme Corp",
  "dateOfBirth": "1995-06-15",
  "workAuthorization": "us_citizen",
  "relocationLocations": [
    "New York, United States",
    "Austin, United States"
  ],
  "salaryCurrency": "usd",
  "availableStartDate": "2026-04-01",
  "noticePeriod": "two_weeks",
  "personalNarrative": "Took a 14-month gap in 2024 for caregiving; returning with a refreshed cloud certification.",
  "travelWillingness": "up_to_25",
  "securityClearance": "none",
  "restrictiveCovenantStatus": "no",
  "criminalRecordStatus": "no",
  "backgroundCheckConsent": "yes",
  "relatedToEmployeeStatus": "no",
  "exportControlUsPerson": "yes",
  "highestEducation": "bachelor",
  "yearsOfExperience": 5,
  "veteranStatus": "prefer_not_to_say",
  "disabilityStatus": "prefer_not_to_say",
  "gender": "prefer_not_to_say",
  "ethnicity": "prefer_not_to_say",
  "sexualOrientation": "prefer_not_to_say",
  "pronouns": "she/her"
}

Response

Application profile created or updated

successtrue required

Example response

{
  "data": {
    "id": "abc-123",
    "userId": "user_abc123",
    "phone": "+1-555-123-4567",
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94105",
    "country": "US",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "portfolioUrl": "https://johndoe.dev",
    "githubUrl": "https://github.com/johndoe",
    "currentEmployer": "Acme Corp",
    "dateOfBirth": "1995-06-15",
    "workAuthorization": "us_citizen",
    "relocationLocations": [
      "New York, United States",
      "Austin, United States"
    ],
    "salaryCurrency": "usd",
    "availableStartDate": "2026-04-01",
    "noticePeriod": "two_weeks",
    "personalNarrative": "Took a 14-month gap in 2024 for caregiving; returning with a refreshed cloud certification.",
    "travelWillingness": "up_to_25",
    "securityClearance": "none",
    "restrictiveCovenantStatus": "no",
    "criminalRecordStatus": "no",
    "backgroundCheckConsent": "yes",
    "relatedToEmployeeStatus": "no",
    "exportControlUsPerson": "yes",
    "highestEducation": "bachelor",
    "yearsOfExperience": 5,
    "veteranStatus": "prefer_not_to_say",
    "disabilityStatus": "prefer_not_to_say",
    "gender": "prefer_not_to_say",
    "ethnicity": "prefer_not_to_say",
    "sexualOrientation": "prefer_not_to_say",
    "pronouns": "she/her",
    "applyReadiness": {
      "missingRequiredForApply": [
        "zip_code",
        "state"
      ]
    },
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-03-10T08:30:00Z"
  },
  "meta": {
    "duration": 150,
    "requestId": "req_abc123",
    "timestamp": "2026-10-13T10:27:20.268Z",
    "version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.