Skip to main content
The registration endpoints guide the process for a receiver to verify their identity and link their wallet address to an SDP. The registration process only needs to happen once per receiver to link their wallet. Only SDP-compatible wallet providers can facilitate the registration process. These endpoints must be supported and hit by the wallet providers after the receiver gets the initial invite. After the wallet address is successfully linked, the payment automatically begins. There are two parts to the registration flow. First, the wallet must authenticate with SEP-10 and initiate a registration flow with SEP-24, using the /sep10/auth and /sep24 endpoints defined below. The Stellar Disbursement Platform hosts these endpoints itself, and its stellar.toml file gives their URLs. SDP versions before 6.0.0 hosted them on a separate Anchor Platform host. The second part of the registration flow is handled by the webview that is opened within the wallet application. This webview uses the /sep24-interactive-deposit endpoints defined below to complete the registration process. The wallet application can choose not to use the webview and instead integrate directly with the API.

Get Receiver Registration Info

Returns the registration context for the receiver, including organization details and reCAPTCHA configuration.

Send One-Time Passcode

This endpoint generates a 6-digit OTP and sends it to the user contact (email or phone number SMS) provided in the request body, as long as it matches the receiver contact info stored in the SDP. A valid SEP-24 token should be included in this request's Authorization header.

Verify Receiver Registration

This endpoint verifies the receiver's registration by validating the OTP and other verification values provided in the request body. A valid SEP-24 token should be included in the Authorization header of the request.

Start Wallet Registration

Serves the SEP-24 interactive registration UI.

Retrieve Stellar Info File

Allows the wallet to fetch the SEP-10 server url, SEP-10 signing public key and SEP-24 server url.

Request Challenge Transaction

Allows the wallet to get the SEP-10 challenge transaction to be signed. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the Get Stellar toml endpoint response under the `WEB_AUTH_ENDPOINT` variable.

Provide Signed Challenge Transaction

Allows the wallet to post the signed SEP-10 challenge transaction. More information [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md#challenge). The endpoint url can change but is provided in the toml file under the `WEB_AUTH_ENDPOINT ` variable.

SEP-24 Info

Returns supported assets and feature flags for SEP-24 registration deposits.

Request Registration URL

The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit. It also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation [here](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#deposit-2).