GET v1/Participant/{id}/validation

Gets a participant's validation status

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the participant to check

 string

Required

Body Parameters

None.

Response Information

Resource Description

A response containing the participant's validation status

ParticipantValidationResponse
NameDescriptionTypeAdditional information
ParticipantId

string

None.
HasValidated

boolean

None.
ValidationUrl

string

None.
ErrorMessage

string

None.

Response Codes

  • 200 OK: Participant's validation status returned.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "ParticipantId": "sample string 1",
  "HasValidated": true,
  "ValidationUrl": "sample string 3",
  "ErrorMessage": "sample string 4"
}

text/html

Sample: 
{"ParticipantId":"sample string 1","HasValidated":true,"ValidationUrl":"sample string 3","ErrorMessage":"sample string 4"}

application/xml, text/xml

Sample: 
<ParticipantValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Responses">
  <ErrorMessage>sample string 4</ErrorMessage>
  <HasValidated>true</HasValidated>
  <ParticipantId>sample string 1</ParticipantId>
  <ValidationUrl>sample string 3</ValidationUrl>
</ParticipantValidationResponse>