Skip to main content
GET
/
v2
/
partner
/
nexus
Get Nexus Report
curl --request GET \
  --url https://api.trykintsugi.com/v2/partner/nexus \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "stateCode": "<string>",
      "countryCode": "<string>",
      "status": "<string>",
      "revenue": "<string>",
      "transactions": 123,
      "economicNexusMet": true,
      "countryDisplay": "<string>",
      "organizationName": "<string>",
      "thresholdPercentage": 123,
      "thresholdMetDate": "2023-12-25",
      "currencyCode": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-partner-id
string | null

Target partner. Required for referral partner API keys (selects the owned sub-partner; omitting it returns 400 PARTNER_ID_REQUIRED). For multi-partner bearer users, selects the active partner.

Maximum string length: 100

Query Parameters

​
client_id
string | null
​
status
enum<string> | null
Available options:
EXPOSED,
APPROACHING,
PENDING_REGISTRATION,
OSS_PENDING_REGISTRATION,
REGISTERED,
OSS_REGISTERED,
NOT_EXPOSED
​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

​
items
PartnerNexusItem · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0