Skip to main content
POST
Attach an identifier

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Body

application/json
target
object
required
system
string
required

Stable customer namespace, limited to 255 UTF-8 bytes

Maximum string length: 255
value
string
required

Exact opaque identifier value, limited to 4096 UTF-8 bytes

Maximum string length: 4096
payload
string

Exact scan payload, limited to 4096 UTF-8 bytes; defaults to value

Maximum string length: 4096
format_hint
string | null
Maximum string length: 64
scan_values
object[]

Additional exact carrier payloads that resolve this identifier

Required array length: 1 - 32 elements
is_primary
boolean

Response

Identifier attached

data
object
required
meta
object
required