> ## Documentation Index > Fetch the complete documentation index at: https://help.awin.com/llms.txt > Use this file to discover all available pages before exploring further. # Get tax profile > Returns the tax profile on file for the publisher. Use it to check the tax residency and registration details held for a publisher's payments. The response always carries `taxResidency` and `taxCompleted`; when `taxResidency` is `BR` the Brazil-specific fields (`cnpjLast4`, `saoPauloRegistered`, `cpfLast4`, `pisLast4`) are also returned, and when it is `MX` the Mexico-specific fields (`taxRegime`, `rfcNumberLast4`) are returned instead. Tax identifiers are masked: only their last four characters are returned. Fields with no recorded value are omitted. Returns `404` if the publisher has no tax profile on file. Read-only, with no side effects. The caller must belong to the publisher account and hold at least the Full Access role on it; otherwise the request is rejected with `403`. ## OpenAPI ````json GET /v1/publishers/{publisherId}/tax-profile { "openapi": "3.0.3", "info": { "title": "Awin Public API", "version": "0.1.0" }, "servers": [ { "url": "https://api.awin.com/public", "description": "Production" } ], "tags": [ { "name": "Advertisers", "description": "Endpoints for advertiser accounts." }, { "name": "Advertisers > Partnerships", "description": "Advertiser partnerships with publishers." }, { "name": "Advertisers > Tracking links", "description": "Advertiser tracking links." }, { "name": "Advertisers > Billing", "description": "Advertiser billing and prepayments." }, { "name": "Publishers", "description": "Endpoints for publisher accounts." }, { "name": "Publishers > Partnerships", "description": "Publisher partnerships with advertisers." }, { "name": "Publishers > Transactions", "description": "Publisher transactions." }, { "name": "Publishers > Payments", "description": "Publisher payments and payment details." } ], "paths": { "/v1/publishers/{publisherId}/tax-profile": { "x-awin-owner": "hqteamapollo", "parameters": [ { "$ref": "#/components/parameters/PublisherId" } ], "get": { "tags": [ "Publishers > Payments" ], "operationId": "getPublisherTaxProfile", "summary": "Get tax profile", "description": "Returns the tax profile on file for the publisher. Use it to check the tax residency and registration details held for a publisher's payments. The response always carries `taxResidency` and `taxCompleted`; when `taxResidency` is `BR` the Brazil-specific fields (`cnpjLast4`, `saoPauloRegistered`, `cpfLast4`, `pisLast4`) are also returned, and when it is `MX` the Mexico-specific fields (`taxRegime`, `rfcNumberLast4`) are returned instead. Tax identifiers are masked: only their last four characters are returned. Fields with no recorded value are omitted. Returns `404` if the publisher has no tax profile on file. Read-only, with no side effects. The caller must belong to the publisher account and hold at least the Full Access role on it; otherwise the request is rejected with `403`.", "x-awin-public-api-authorization": { "accountType": "publisher", "minRole": "userFullAccess" }, "x-awin-audience": "public", "responses": { "200": { "description": "The publisher's tax profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxProfile" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "$ref": "#/components/responses/UnexpectedError" } }, "security": [ { "patBearer": [] } ] } } }, "components": { "parameters": { "PublisherId": { "name": "publisherId", "in": "path", "required": true, "description": "Identifier of the publisher account.", "schema": { "type": "string", "pattern": "^[0-9]+$", "example": "45678" } } }, "schemas": { "TaxProfile": { "type": "object", "additionalProperties": false, "description": "Tax profile recorded for a publisher. The common fields apply to every tax residency. The Brazil-specific fields are returned only when `taxResidency` is `BR`, and the Mexico-specific fields only when `taxResidency` is `MX`; for any other residency they are omitted. Fields with no recorded value are omitted. Tax identifiers are never returned in full; only their last four characters are returned, in the `*Last4` fields. New fields and new enum values may be added without a new major version (APIG-6.1, APIG-4A.8); a consumer MUST treat an unrecognised enum value as a non-fatal case.", "required": [ "taxResidency", "taxCompleted" ], "properties": { "taxResidency": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the country the publisher is tax resident in. Determines which country-specific fields are returned.", "example": "BR" }, "businessType": { "type": "string", "enum": [ "REGISTERED_COMPANY", "MICRO_ENTREPRENEUR", "SOLE_TRADER", "REGISTERED_COMPANY_GLOBAL", "SOLE_TRADER_GLOBAL", "C_CORPORATION", "S_CORPORATION", "PARTNERSHIP", "TRUST_ESTATE", "LIMITED_LIABILITY_COMPANY_C", "LIMITED_LIABILITY_COMPANY_S", "LIMITED_LIABILITY_COMPANY_P", "INDIVIDUAL_SOLE_PROPRIETOR_OR_SINGLE_MEMBER_LLC" ], "description": "Type of business the publisher is registered as. New values may be added without a new major version; a consumer MUST tolerate an unrecognised value.", "example": "REGISTERED_COMPANY" }, "companyName": { "type": "string", "maxLength": 200, "description": "Registered company name. Omitted if not recorded.", "example": "Example Ltda" }, "taxCompleted": { "type": "boolean", "description": "Whether the publisher has completed their tax profile.", "example": true }, "euVatRegistered": { "type": "boolean", "description": "Whether the publisher is registered for VAT in the EU.", "example": false }, "localTaxNumberLast4": { "type": "string", "pattern": "^[A-Za-z0-9]{1,4}$", "description": "Last four characters of the tax number issued by the publisher's local tax authority, ignoring spaces and punctuation. Fewer than four characters are returned if the recorded number is shorter. The full number is not returned. Not returned when the tax number is a CNPJ, CPF or RFC; those are returned in `cnpjLast4`, `cpfLast4` and `rfcNumberLast4`.", "example": "5678" }, "address": { "allOf": [ { "$ref": "#/components/schemas/TaxProfileAddress" } ], "description": "Address recorded for the publisher's tax profile." }, "cnpjLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Brazil only (`taxResidency` is `BR`). Last four digits of the CNPJ, the Brazilian company tax registration number. The full number is not returned.", "example": "0195" }, "saoPauloRegistered": { "type": "boolean", "description": "Brazil only (`taxResidency` is `BR`). Whether the publisher is registered in São Paulo.", "example": true }, "cpfLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Brazil only (`taxResidency` is `BR`). Last four digits of the CPF, the Brazilian individual taxpayer registration number. The full number is not returned.", "example": "8909" }, "pisLast4": { "type": "string", "pattern": "^[0-9]{4}$", "description": "Brazil only (`taxResidency` is `BR`). Last four digits of the PIS, the Brazilian social integration programme number. The full number is not returned.", "example": "8919" }, "taxRegime": { "type": "string", "enum": [ "GENERAL", "INDIVIDUALS_WITH_BUSINESS_AND_PROFESSIONAL_ACTIVITIES", "SIMPLIFIED_TRUST_REGIME" ], "description": "Mexico only (`taxResidency` is `MX`). Tax regime the publisher is registered under. New values may be added without a new major version; a consumer MUST tolerate an unrecognised value.", "example": "GENERAL" }, "rfcNumberLast4": { "type": "string", "pattern": "^[A-Z0-9]{4}$", "description": "Mexico only (`taxResidency` is `MX`). Last four characters of the RFC, the Mexican federal taxpayer registry number. The full number is not returned.", "example": "1000" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the tax profile was last updated, as an RFC 3339 UTC timestamp with a `Z` offset.", "example": "2026-07-21T09:14:23.123Z" } } }, "TaxProfileAddress": { "type": "object", "additionalProperties": false, "description": "Postal address recorded for the publisher's tax profile.", "required": [ "country" ], "properties": { "addressLine1": { "type": "string", "maxLength": 200, "description": "First line of the address. Omitted if not recorded.", "example": "1 Example Street" }, "addressLine2": { "type": "string", "maxLength": 200, "description": "Second line of the address. Omitted if not recorded.", "example": "Floor 2" }, "city": { "type": "string", "maxLength": 100, "description": "City or town. Omitted if not recorded.", "example": "London" }, "region": { "type": "string", "maxLength": 100, "description": "State, province or region. Omitted if not recorded.", "example": "Greater London" }, "postalCode": { "type": "string", "maxLength": 20, "description": "Postal or ZIP code. Omitted if not recorded.", "example": "EC1A 1BB" }, "country": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO 3166-1 alpha-2 code of the address country.", "example": "GB" } } }, "ValidationProblem": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "description": "A problem detail carrying the RFC 9457 extension member `errors`, used where a request fails validation on one or more specific fields.", "properties": { "errors": { "type": "array", "description": "One entry per field that failed validation.", "items": { "type": "object", "required": [ "pointer", "detail" ], "properties": { "pointer": { "type": "string", "description": "An [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901) JSON Pointer to the offending field in the request.", "example": "/name" }, "detail": { "type": "string", "description": "A human-readable explanation of this field's failure.", "example": "must be 100 characters or fewer" } } } } } } ] }, "Problem": { "type": "object", "description": "Problem details for an HTTP API error, as defined by [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). Served as `application/problem+json`.", "required": [ "title", "status", "detail", "code" ], "properties": { "type": { "type": "string", "format": "uri-reference", "default": "https://help.awin.com/apis/error", "description": "A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.", "example": "https://help.awin.com/apis/error" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.", "example": "Not Found" }, "status": { "type": "integer", "description": "The HTTP status code, repeated here for convenience.", "example": 404 }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.", "example": "Resource not found with that ID" }, "instance": { "type": "string", "format": "uri-reference", "description": "A URI reference identifying this specific occurrence, typically the request path.", "example": "/v1/advertisers/12345/prepayments" }, "code": { "type": "string", "description": "A stable, machine-readable error code. It does not change when `detail` is reworded, so clients branch on `code`, never on `detail`.", "enum": [ "VALIDATION_FAILED", "INVALID_SORT", "UNAUTHORIZED", "MISSING_TOKEN", "INVALID_TOKEN", "FORBIDDEN", "ACCESS_DENIED", "CLIENT_NOT_CONFIGURED", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "CONFLICT", "CONTENT_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "BUSINESS_RULE_VIOLATION", "TOO_MANY_REQUESTS", "USER_RATE_LIMIT_EXCEEDED", "ROUTE_RATE_LIMIT_EXCEEDED", "LINK_SHORTENER_QUOTA_EXCEEDED", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "DEPENDENCY_UNAVAILABLE", "GATEWAY_TIMEOUT", "FEATURE_NOT_ENABLED", "ACCOUNT_IN_DEBT", "DUPLICATE_ENQUIRY_ID", "TRANSACTION_QUERY_NOT_PENDING", "MEMBERSHIP_INACTIVE", "ORDER_REF_ALREADY_TRACKED", "ORDER_REF_ALREADY_QUERIED", "TRANSACTION_DATE_BEFORE_ADVERTISER_LIVE_DATE", "CURRENCY_NOT_SUPPORTED", "CURRENCY_MISMATCH", "TRANSACTION_DATE_IN_FUTURE", "TRANSACTION_DATE_TOO_OLD", "OVERRIDE_NOT_ALLOWED" ], "example": "NOT_FOUND" } } } }, "headers": { "RateLimitLimit": { "description": "Maximum number of requests you can make in a burst under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 1, "example": 5 } }, "RateLimitRemaining": { "description": "Number of requests you have left under your own rate limit. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 0 } }, "RateLimitReset": { "description": "Number of seconds until your own rate limit is fully restored. Absent when the request did not count against your own limit.", "schema": { "type": "integer", "minimum": 0, "example": 1 } }, "RetryAfter": { "description": "Number of seconds to wait before retrying the request.", "required": true, "schema": { "type": "integer", "minimum": 0, "example": 1 } } }, "responses": { "BadRequest": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Bad Request", "status": 400, "detail": "Required parameters are missing from the request", "code": "VALIDATION_FAILED", "errors": [ { "pointer": "/name", "detail": "must be 100 characters or fewer" } ] } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "Unauthorized": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Unauthorized", "status": 401, "detail": "No valid credentials were supplied with the request", "code": "UNAUTHORIZED" } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Forbidden", "status": 403, "detail": "You do not have the correct privileges to access this resource", "code": "FORBIDDEN" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "NotFound": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Not Found", "status": 404, "detail": "Resource not found with that ID", "code": "NOT_FOUND" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } }, "TooManyRequests": { "description": "Too Many Requests", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "userRateLimitExceeded": { "value": { "type": "https://help.awin.com/apis/error", "title": "User rate limit exceeded", "status": 429, "detail": "You have exceeded your rate limit across the public API. Retry after the number of seconds in the Retry-After header", "code": "USER_RATE_LIMIT_EXCEEDED" } }, "routeRateLimitExceeded": { "value": { "type": "https://help.awin.com/apis/error", "title": "Route rate limit exceeded", "status": 429, "detail": "This endpoint is receiving more requests than it can accept right now. Retry after the number of seconds in the Retry-After header", "code": "ROUTE_RATE_LIMIT_EXCEEDED" } }, "tooManyRequests": { "value": { "type": "https://help.awin.com/apis/error", "title": "Too Many Requests", "status": 429, "detail": "Rate limit exceeded", "code": "TOO_MANY_REQUESTS" } } } } } }, "ServiceUnavailable": { "description": "Service Unavailable", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Service Unavailable", "status": 503, "detail": "The service is temporarily unavailable", "code": "SERVICE_UNAVAILABLE" } } } }, "UnexpectedError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "https://help.awin.com/apis/error", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred", "code": "INTERNAL_ERROR" } } }, "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" } } } }, "securitySchemes": { "patBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Personal Access Token, sent as `Authorization: Bearer `." } } } } ````