Get Onboarding Status

Get the current onboarding status for the authenticated user. Returns a tagged union indicating the current step and any required actions.

GET /user/onboarding

Get Onboarding Status

JavaScript

const options = {method: 'GET'};

fetch('https://gp-auth-module.prod.gnosispay.com/user/onboarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://gp-auth-module.prod.gnosispay.com/user/onboarding

import requests

url = "https://gp-auth-module.prod.gnosispay.com/user/onboarding"

response = requests.get(url)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gp-auth-module.prod.gnosispay.com/user/onboarding"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://gp-auth-module.prod.gnosispay.com/user/onboarding")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gp-auth-module.prod.gnosispay.com/user/onboarding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "status": "action_accept_tos",
  "terms": [
    {
      "type": "<string>",
      "currentVersion": "<string>",
      "name": "<string>",
      "url": "<string>",
      "accepted": true,
      "acceptedVersion": "<string>",
      "acceptedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

Response

200

application/json

Onboarding status retrieved successfully

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

status · enum<string> · required

Available options: action_accept_tos

terms · object[] · required

Show child attributes