Get a tax form

POST

/getTaxForm

Account holders

Generates a tax form for account holders operating in the US. For more information, refer to Providing tax forms.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/getTaxForm' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string",
    "formType": "string",
    "year": 0
}'

Response Example

200 - Example 1

{
  "content": "string",
  "contentType": "string",
  "invalidFields": [
    {
      "errorCode": 0,
      "errorDescription": "string",
      "fieldType": {
        "field": "string",
        "fieldName": "accountCode",
        "shareholderCode": "string"
      }
    }
  ],
  "pspReference": "string",
  "resultCode": "string"
}

Request

Body Params application/json

accountHolderCode

string

required

The account holder code you provided when you created the account holder.

formType

string

required

Type of the requested tax form. For example, 1099-K.

year

integer <int32>

required

Applicable tax year in the YYYY format.

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

content

string

optional

The content of the tax form in the Base64 binary format.

contentType

string

optional

The content type of the tax form.

invalidFields

array[object (ErrorFieldType) {3}]

optional

Contains field validation errors that would prevent requests from being processed.

errorCode

integer <int32>

optional

The validation error code.

errorDescription

string

optional

A description of the validation error.

fieldType

object (FieldType)

optional

The type of error field.

pspReference

string

optional

The reference of a request. Can be used to uniquely identify the request.

resultCode

string

optional

The result code.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Modified at 2023-08-15 06:33:33

Get an account holder

Suspend an account holder