Jump to

• Request
• Response

Create a candidate authenticity check

post

/hcmRestApi/resources/11.13.18.05/recruitingCandidateAuthChecks

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address: string
  Address of the candidate associated with the authenticity check.
• AddressRiskScore: string
  Indicates the risk score associated with the candidate's address.
• EmailAddress: string
  Email address of the candidate associated with the authenticity check.
• EmailAddressRiskScore: string
  Default Value: 0.00

  Indicates the risk score associated with the candidate's email address.
• FullName: string
  Full name of the candidate associated with the authenticity check.
• FullNameRiskScore: string
  Default Value: 0.00

  Indicates the risk score associated with the candidate's full name.
• IpAddress: string
  IP address of the candidate accessing the authenticity checks.
• IpAddressRiskScore: string
  Default Value: 0.00

  Indicates the risk score associated with the IP address of the candidate.
• Message: string
  Message associated with the candidate authenticity check.
• OverallRiskScore: string
  Default Value: 0.00

  Overall risk score for the candidate's authenticity checks.
• PersonId: string
  Unique identifier of the person associated with the candidate authenticity check.
• PhoneNumber: string
  Phone number of the candidate associated with the authenticity check.
• PhoneNumberRiskScore: string
  Phone number risk score for the candidate's authenticity check.
• Status: string
  Indicates the status of the candidate authenticity check.
• StatusCode: string
  Indicates the status code of the candidate authenticity check.

{
    "type":"object",
    "properties":{
        "Address":{
            "type":"string",
            "description":"Address of the candidate associated with the authenticity check.",
            "nullable":true
        },
        "AddressRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the candidate's address.",
            "nullable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"Email address of the candidate associated with the authenticity check.",
            "nullable":true
        },
        "EmailAddressRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the candidate's email address.",
            "nullable":true,
            "default":"0.00"
        },
        "FullName":{
            "type":"string",
            "description":"Full name of the candidate associated with the authenticity check.",
            "nullable":true
        },
        "FullNameRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the candidate's full name.",
            "nullable":true,
            "default":"0.00"
        },
        "IpAddress":{
            "type":"string",
            "description":"IP address of the candidate accessing the authenticity checks.",
            "nullable":true
        },
        "IpAddressRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the IP address of the candidate.",
            "nullable":true,
            "default":"0.00"
        },
        "Message":{
            "type":"string",
            "description":"Message associated with the candidate authenticity check.",
            "nullable":true
        },
        "OverallRiskScore":{
            "type":"string",
            "description":"Overall risk score for the candidate's authenticity checks.",
            "nullable":true,
            "default":"0.00"
        },
        "PersonId":{
            "type":"string",
            "description":"Unique identifier of the person associated with the candidate authenticity check.",
            "nullable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"Phone number of the candidate associated with the authenticity check.",
            "nullable":true
        },
        "PhoneNumberRiskScore":{
            "type":"string",
            "description":"Phone number risk score for the candidate's authenticity check.",
            "nullable":true
        },
        "Status":{
            "type":"string",
            "description":"Indicates the status of the candidate authenticity check.",
            "nullable":true
        },
        "StatusCode":{
            "type":"string",
            "description":"Indicates the status code of the candidate authenticity check.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : recruitingCandidateAuthChecks-item-response

Type: object

Show Source

• Address: string
  Address of the candidate associated with the authenticity check.
• AddressRiskScore: string
  Indicates the risk score associated with the candidate's address.
• EmailAddress: string
  Email address of the candidate associated with the authenticity check.
• EmailAddressRiskScore: string
  Default Value: 0.00

  Indicates the risk score associated with the candidate's email address.
• FullName: string
  Full name of the candidate associated with the authenticity check.
• FullNameRiskScore: string
  Default Value: 0.00

  Indicates the risk score associated with the candidate's full name.
• IpAddress: string
  IP address of the candidate accessing the authenticity checks.
• IpAddressRiskScore: string
  Default Value: 0.00

  Indicates the risk score associated with the IP address of the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Message associated with the candidate authenticity check.
• OverallRiskScore: string
  Default Value: 0.00

  Overall risk score for the candidate's authenticity checks.
• PersonId: string
  Unique identifier of the person associated with the candidate authenticity check.
• PhoneNumber: string
  Phone number of the candidate associated with the authenticity check.
• PhoneNumberRiskScore: string
  Phone number risk score for the candidate's authenticity check.
• Status: string
  Indicates the status of the candidate authenticity check.
• StatusCode: string
  Indicates the status code of the candidate authenticity check.

{
    "type":"object",
    "properties":{
        "Address":{
            "type":"string",
            "description":"Address of the candidate associated with the authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the candidate's address.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "type":"string",
            "description":"Email address of the candidate associated with the authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddressRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the candidate's email address.",
            "nullable":true,
            "default":"0.00",
            "x-queryable":true
        },
        "FullName":{
            "type":"string",
            "description":"Full name of the candidate associated with the authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "FullNameRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the candidate's full name.",
            "nullable":true,
            "default":"0.00",
            "x-queryable":true
        },
        "IpAddress":{
            "type":"string",
            "description":"IP address of the candidate accessing the authenticity checks.",
            "nullable":true,
            "x-queryable":true
        },
        "IpAddressRiskScore":{
            "type":"string",
            "description":"Indicates the risk score associated with the IP address of the candidate.",
            "nullable":true,
            "default":"0.00",
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Message associated with the candidate authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "OverallRiskScore":{
            "type":"string",
            "description":"Overall risk score for the candidate's authenticity checks.",
            "nullable":true,
            "default":"0.00",
            "x-queryable":true
        },
        "PersonId":{
            "type":"string",
            "description":"Unique identifier of the person associated with the candidate authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"Phone number of the candidate associated with the authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumberRiskScore":{
            "type":"string",
            "description":"Phone number risk score for the candidate's authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Indicates the status of the candidate authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "type":"string",
            "description":"Indicates the status code of the candidate authenticity check.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top