Skip to main content
Request Registration URL

Authorizations

Authorization
string
header
required

Authorization header containing a SEP-10 JWT (Bearer {token}).

Body

asset_code
string
required

Stellar asset code for the deposit.

account
string

Stellar account for the deposit; defaults to the SEP-10 subject.

lang
string

Language for the interactive flow.

claimable_balance_supported
string

Indicates if claimable balances are supported.

Response

An anchor requires the user to fill out information on a webpage hosted by the anchor.

type
string

Always set to interactive_customer_info_needed.

Example:

"interactive_customer_info_needed"

url
string

URL hosted by the anchor. The wallet should show this URL to the user as a popup.

Example:

"https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI"

id
string

The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request.

Example:

"82fhs729f63dh0v4"