Create or update a candidate.

POST

/Candidate

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The request has succeeded.

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.triowfs.com/trio/Candidate' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Number": 183430,
    "FirstName": "Dannie",
    "MiddleName": null,
    "LastName": "Smith",
    "Title": null,
    "AddressLine1": "123 Test",
    "AddressLine2": null,
    "City": null,
    "StateAbbreviation": null,
    "ZipCode": null,
    "PermanentAddressLine1": null,
    "PermanentAddressLine2": null,
    "PermanentCity": null,
    "PermanentStateAbbrevation": "OK",
    "PermanentZipCode": null,
    "PhoneNumber": null,
    "AlternativePhoneNumber": null,
    "EmailAddress": "danniesmith@email.com",
    "AlternativeEmailAddress": null,
    "DriversLicenseNumber": null,
    "Identification": "Expedient Medstaff",
    "BirthDate": "2000-01-01",
    "ExperienceYears": null,
    "TravelExperienceYears": null,
    "ExperienceDescription": null,
    "IsAlcoholFree": false,
    "IsNicotineFree": false,
    "IsConvicted": false,
    "ConvictedDescription": null,
    "IsSuspended": false,
    "SuspendedDescription": null,
    "Description": null,
    "Note": null,
    "Specialties": [],
    "Certifications": [],
    "StateLicenses": [],
}'

Response Example

200 - Example 1

{
    "Number": 0,
    "AgencyName": "string",
    "AgencyNumber": 0,
    "Name": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Title": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "State": "string",
    "StateAbbreviation": "string",
    "ZipCode": "string",
    "PermanentAddressLine1": "string",
    "PermanentAddressLine2": "string",
    "PermanentCity": "string",
    "PermanentState": "string",
    "PermanentStateAbbreviation": "string",
    "PermanentZipCode": "string",
    "PhoneNumber": "string",
    "AlternativePhoneNumber": "string",
    "EmailAddress": "string",
    "AlternativeEmailAddress": "string",
    "DriversLicenseNumber": "string",
    "Identification": "string",
    "BirthDate": "2019-08-24",
    "ExperienceYears": 0,
    "TravelExperienceYears": 0,
    "ExperienceDescription": "string",
    "IsAlcoholFree": true,
    "IsNicotineFree": true,
    "IsConvicted": true,
    "ConvictedDescription": "string",
    "IsSuspended": true,
    "SuspendedDescription": "string",
    "Description": "string",
    "Specialties": [
        {
            "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43",
            "ProfessionId": "6758a7a0-8526-4030-94c2-e425266d45e5",
            "Name": "string",
            "ProfessionName": "string",
            "Code": 0,
            "Description": "string",
            "Active": true,
            "ExternalIdentifiers": [
                {
                    "sourceCode": "string",
                    "code": "string",
                    "value": "string"
                }
            ],
            "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
        }
    ],
    "Certifications": [
        {
            "Code": 0,
            "Name": "string",
            "Description": "string",
            "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
        }
    ],
    "StateLicenses": [
        {
            "State": "string",
            "Abbreviation": "string",
            "IsCompact": true,
            "ExpirationDate": "2019-08-24"
        }
    ],
    "ExternalIdentifiers": [
        {
            "sourceCode": "string",
            "code": "string",
            "value": "string"
        }
    ],
    "SocialSecurityNumber": "string",
    "Note": "string",
    "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-04-08 18:58:17

Get a list of all active candidates related to your account.

Gets information for the specified candidate.