Deploy and Setup a Safe

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dailyLimit: 350})
};

fetch('https://api.gnosispay.com/api/v1/safe/deploy', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "accepted"
}

Safe Management

Deploy and Setup a Safe

Deploys and sets up the Safe account for the authenticated user. The User needs to be KYC approved.

This endpoint replaces the POST /api/v1/account and related endpoints. Using this endpoint, the user can deploy the Safe without having to sign the data.

This endpoint is idempotent: calling it again while a deployment is already in flight for the same user will return 202 without starting a new workflow. Use GET /api/v1/safe/deploy as the source of truth for deployment status (processing, ok, failed, not_deployed).

POST

api

safe

deploy

Deploy and Setup a Safe

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dailyLimit: 350})
};

fetch('https://api.gnosispay.com/api/v1/safe/deploy', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "accepted"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

dailyLimit

integer

The daily spending allowance to configure for the Safe, in whole token units (no decimals). Defaults to 350 if omitted.

Required range: x >= 1

Example:

350

Response

Accepted the deployment request. The partner should check the status of the deployment with the GET /api/v1/safe/deploy endpoint.

status

string

The status of the deployment.

Example:

"accepted"

Get the Safe deployment status.Reset Safe Account

⌘I