What's Changed

POST /candidates

Request:

Changed content type : application/json

• Added property isPassEnabled (boolean)

  Turns on candidate pass functionality for this candidate. If true, candidate will be able to use candidate pass.

GET /candidates

Parameters:

Added: includePass in query

You can include candidate 'candidatePass' relation

Added: includePassLastActiveVerification in query

You can include candidate 'pass' relation with embedded last active verification

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  Changed items (object): > Immutable candidate properties

  • Added property pass (object)

    Candidate Pass entity

    • Property id (string)

      Unique identifier for the entity

    • Property accountPassId (string)

      Unique identifier for the entity

    • Property candidateId (string)

      Unique identifier for the entity

    • Property companyId (string)

      Unique identifier for the entity

    • Property createdAt (string)

      Datetime in ISO format

    • Property updatedAt (string)

      Datetime in ISO format

    • Property lastActiveVerification (object)

      Candidate Pass Verification entity

      • Property id (string)

        Unique identifier for the entity

      • Property status (string)

        Verification status

        Enum values:

        • initiated
        • verified
        • failed
        • expired

      • Property candidatePassId (string)

        Unique identifier for the entity

      • Property expiresAt (string)

        Datetime in ISO format

      • Property verifiedAt (string)

        Datetime in ISO format

      • Property createdAt (string)

        Datetime in ISO format

      • Property updatedAt (string)

        Datetime in ISO format

    • Property isEnabled (boolean)

      Whether this candidate pass is active

PATCH /candidates/{id}

Request:

Changed content type : application/json

• Added property isPassEnabled (boolean)

  Turns on candidate pass functionality for this candidate. If true, candidate will be able to use candidate pass.

GET /candidates/{id}

Parameters:

Added: includePass in query

You can include candidate 'candidatePass' relation

Added: includePassLastActiveVerification in query

You can include candidate 'pass' relation with embedded last active verification

Return Type:

Changed response : 200 OK

Request was successful

• Changed content type : application/json

  • Added property pass (object)

    Candidate Pass entity