Submit all details of verification token
post
/hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens
Request
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccessCode: string
Access Code in the verification token.
-
AccessCodeExpirationDate: string
(date-time)
Expiration date of the access code.
-
AttemptsRemaining: integer
Number of attempts remaining to validate the short code.
-
CandidateNumber: string
Candidate Number in the verification token.
-
CaptchaToken: string
Token used to validate the CAPTCHA.
-
ChallengeFlag: boolean
Indicates a short code challenge is required for verification.
-
ConsumerResponse: string
Consumer Response in the verification token.
-
Control: string
Maximum Length:
255
Control field used for security. -
CookieId: string
ID assigned to each cookie identifying the user.
-
CookieMatchedFlag: boolean
Indicates that the cookie matched with expected value for the user.
-
DateOfBirth: string
Date of birth for the user.
-
Email: string
Email in the verification token.
-
IndeedKey: string
Key used for verifying the login with Indeed.
-
LastName: string
Last Name of the user.
-
Mode: string
Mode in the verification token.
-
NextField: string
Maximum Length:
255
Next field required for the validation failure. -
PersistAccessFlag: boolean
Indicates whether the request to keep the user signed in across sessions is enabled or disabled.
-
Phone: string
Phone number in the verification token.
-
PhoneLegislationCode: string
Maximum Length:
255
Legislation code of the phone number in the verification token. -
RequisitionNumber: string
Requisition Number in the verification token.
-
ResendFlag: boolean
Maximum Length:
255
Resend indicator in the verification token. -
ShortCode: integer
Short code for verification.
-
SiteNumber: string
Site Number in the verification token.
-
SourceTrackingId: integer
(int64)
Source Tracking ID in the verification token.
-
Target: string
Target URL after the shortened URL is resolved
-
Token: string
Token in the verification token.
-
TokenId: integer
(int64)
Token ID in the verification token.
-
URLShortCode: string
Shortened URL to resolve on CE.
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.
Root Schema : recruitingCEVerificationTokens-item-response
Type:
Show Source
object
-
AccessCode: string
Access Code in the verification token.
-
AccessCodeExpirationDate: string
(date-time)
Expiration date of the access code.
-
AttemptsRemaining: integer
Number of attempts remaining to validate the short code.
-
CandidateNumber: string
Candidate Number in the verification token.
-
CaptchaToken: string
Token used to validate the CAPTCHA.
-
ChallengeFlag: boolean
Indicates a short code challenge is required for verification.
-
ConsumerResponse: string
Consumer Response in the verification token.
-
Control: string
Maximum Length:
255
Control field used for security. -
CookieId: string
ID assigned to each cookie identifying the user.
-
CookieMatchedFlag: boolean
Indicates that the cookie matched with expected value for the user.
-
DateOfBirth: string
Date of birth for the user.
-
Email: string
Email in the verification token.
-
IndeedKey: string
Key used for verifying the login with Indeed.
-
LastName: string
Last Name of the user.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Mode: string
Mode in the verification token.
-
NextField: string
Maximum Length:
255
Next field required for the validation failure. -
PersistAccessFlag: boolean
Indicates whether the request to keep the user signed in across sessions is enabled or disabled.
-
Phone: string
Phone number in the verification token.
-
PhoneLegislationCode: string
Maximum Length:
255
Legislation code of the phone number in the verification token. -
RequisitionNumber: string
Requisition Number in the verification token.
-
ResendFlag: boolean
Maximum Length:
255
Resend indicator in the verification token. -
ShortCode: integer
Short code for verification.
-
SiteNumber: string
Site Number in the verification token.
-
SourceTrackingId: integer
(int64)
Source Tracking ID in the verification token.
-
Target: string
Target URL after the shortened URL is resolved
-
Token: string
Token in the verification token.
-
TokenId: integer
(int64)
Token ID in the verification token.
-
URLShortCode: string
Shortened URL to resolve on CE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.