Handshake Web Service
MethodHandshakeOperation
Handshake Web Service > All Operations Resource Group : HandshakeOperation (Method)
Request (HandshakeRequest)

The request body is of type HandshakeRequest.

Version Element Name Element Sequence SoftwareUsed Element AgentTain Element EmployerRegistrationNumber Element Sequence HandshakeRequest Element

Overview

HandshakeRequest
Handshake Request.
Sequence
EmployerRegistrationNumber optional employerReg Simple Type
Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Tax Advisor Identification Number. Required if Handshake is queried by agent on behalf of employer.
SoftwareUsed SoftwareUsed Complex Type
References to third party software used to Handshake.
Sequence
Name NonEmptyString Simple Type
Name of the software used.
Version NonEmptyString Simple Type
Version of the software used.
200 Response (HandshakeResponse)

The response body is of type HandshakeResponse.

Description Element Path Element Code Element Sequence ValidationError Element ConnectionStatus Element Sequence HandshakeResponse Element

Overview

HandshakeResponse
Handshake Response. Will either return Handshake detail or details of validation errors.
Sequence
ConnectionStatus defaultString Simple Type
Status of connection to be confirmed.
ValidationError 0..∞ Error Complex Type
Data Item Ref: N/A. List of Validation errors (if any) on the HandshakeRequest.
Sequence
Code errorCode Simple Type
Technical Error Code - to be used for mapping to error messages.
Path optional errorPath Simple Type
Path to error in schema, if available.
Description errorDescription Simple Type
Description of error - to be used for support.
See Also
All Operations Resource Group | Handshake Web Service

Please register for our PIT Support Help Desk for the following: