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.
Personal Access Token, sent as Authorization: Bearer <token>.
Identifier of the publisher account.
The publisher's tax profile.
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.
ISO 3166-1 alpha-2 code of the country the publisher is tax resident in. Determines which country-specific fields are returned.
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.
Registered company name. Omitted if not recorded.
Whether the publisher has completed their tax profile.
Whether the publisher is registered for VAT in the EU.
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.
Address recorded for the publisher's tax profile.
First line of the address. Omitted if not recorded.
Second line of the address. Omitted if not recorded.
City or town. Omitted if not recorded.
State, province or region. Omitted if not recorded.
Postal or ZIP code. Omitted if not recorded.
ISO 3166-1 alpha-2 code of the address country.
Brazil only (taxResidency is BR). Last four digits of the CNPJ, the Brazilian company tax registration number. The full number is not returned.
Brazil only (taxResidency is BR). Whether the publisher is registered in São Paulo.
Brazil only (taxResidency is BR). Last four digits of the CPF, the Brazilian individual taxpayer registration number. The full number is not returned.
Brazil only (taxResidency is BR). Last four digits of the PIS, the Brazilian social integration programme number. The full number is not returned.
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.
Mexico only (taxResidency is MX). Last four characters of the RFC, the Mexican federal taxpayer registry number. The full number is not returned.
When the tax profile was last updated, as an RFC 3339 UTC timestamp with a Z offset.
Bad Request
{
"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"
}
]
}A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
One entry per field that failed validation.
A human-readable explanation of this field's failure.
Unauthorized
{
"type": "https://help.awin.com/apis/error",
"title": "Unauthorized",
"status": 401,
"detail": "No valid credentials were supplied with the request",
"code": "UNAUTHORIZED"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Forbidden
{
"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"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Not Found
{
"type": "https://help.awin.com/apis/error",
"title": "Not Found",
"status": 404,
"detail": "Resource not found with that ID",
"code": "NOT_FOUND"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Too Many Requests
{
"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"
}{
"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"
}{
"type": "https://help.awin.com/apis/error",
"title": "Too Many Requests",
"status": 429,
"detail": "Rate limit exceeded",
"code": "TOO_MANY_REQUESTS"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Service Unavailable
{
"type": "https://help.awin.com/apis/error",
"title": "Service Unavailable",
"status": 503,
"detail": "The service is temporarily unavailable",
"code": "SERVICE_UNAVAILABLE"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.
Internal Server Error
{
"type": "https://help.awin.com/apis/error",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Problem details for an HTTP API error, as defined by RFC 9457. Served as application/problem+json.
A URI reference identifying the problem type. APIs SHOULD define a stable, dereferenceable URI per domain-specific problem type.
A short, human-readable summary of the problem type. Stable across occurrences; does not change from occurrence to occurrence.
The HTTP status code, repeated here for convenience.
A human-readable explanation specific to this occurrence. Intended for the developer, not the end user — do not parse it.
A URI reference identifying this specific occurrence, typically the request path.
A stable, machine-readable error code. It does not change when detail is reworded, so clients branch on code, never on detail.