Skip to content

Add (or upsert) a nexus registration

POST
/v1/portability/nexus

Adds a new nexus record or upserts an existing one for the calling account. Idempotent: posting the same (state, nexus_type) twice updates the second time rather than duplicating.

X-API-Key
Any of:
string
NexusItem

A single nexus registration record. Each represents one state in which the account has tax-collection obligation (physical presence, economic threshold, or marketplace facilitator).

object
state
required
State

Two-letter USPS state code.

string
>= 2 characters <= 2 characters /^[A-Za-z]{2}$/
nexus_type
Nexus Type

Reason for collection in this state. physical = office/warehouse/employee/inventory presence; economic = exceeded the state’s sales/transaction threshold; marketplace = marketplace facilitator obligation. Default is physical.

string
default: physical /^(physical|economic|marketplace)$/
registered_at
Any of:
string
/^\d{4}-\d{2}-\d{2}$/
address
Any of:
string
notes
Any of:
string

Nexus record created or upserted.

Response Add Account Nexus V1 Portability Nexus Post
object
key
additional properties
any

Body validation failed (invalid state, invalid nexus_type, malformed date).

Missing or invalid API key.

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object