POST v2/Participant/{id}/collection

Creates a new participant or updates an existing participant and collects the Name and TIN combination

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique identifier of the participant

 string

Required

Body Parameters

TINRequest
NameDescriptionTypeAdditional information
TIN

string

None.
Name

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "TIN": "sample string 1",
  "Name": "sample string 2"
}

text/html

Sample: 
{"TIN":"sample string 1","Name":"sample string 2"}

application/xml, text/xml

Sample: 
<TINRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Models">
  <Name>sample string 2</Name>
  <TIN>sample string 1</TIN>
</TINRequest>

Response Information

Resource Description

A response containing the participant's collection status including failure results for invalidity of TIN.

TaxCollectionResponse
NameDescriptionTypeAdditional information
HasValidated

boolean

None.
HasCollected

boolean

None.
Messages

Collection of string

None.

Response Codes

  • 200 OK: Participant's tax information collected.
  • 401 Unauthorized:
  • 403 Forbidden: Participant is locked out and name and tin combination will not be validated.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "HasValidated": true,
  "HasCollected": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample: 
{"HasValidated":true,"HasCollected":true,"Messages":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample: 
<TaxCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Responses">
  <HasCollected>true</HasCollected>
  <HasValidated>true</HasValidated>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
</TaxCollectionResponse>