Skip to navigation

Register a roaming identity

Adds a country code + party id to issue tokens under. Each pair can be registered once.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringRequired1-255 characters
A unique key you choose for this call, e.g. a UUID. Retrying with the same key returns the first result instead of acting twice.

Request

This endpoint expects an object.
country_codestringRequiredformat: "^[A-Z]{2}$"
party_idstringRequiredformat: "^[A-Z0-9]{3}$"
labelstring or nullOptional<=255 characters
contact_emailstring or nullOptional<=255 characters
contact_phonestring or nullOptional<=50 characters
default_network_accessboolean or nullOptionalDefaults to true

Response

The registered identity.
emp_identity_idinteger
country_codestring
party_idstring
protocolstring
default_network_accessboolean
status"ACTIVE" or any
created_atdatetime
updated_atdatetime
labelstring or nullOptional
contact_emailstring or nullOptional
contact_phonestring or nullOptional

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error