Create or Deploy a Safe (pending Setup)

const url = 'https://api.gnosispay.com/api/v1/account';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"chainId":"100"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": "safe-account-id-123",
  "address": "0x1234567890123456789012345678901234567890",
  "userId": "user123",
  "chainId": "100",
  "salt": "some-salt-value",
  "createdAt": "2024-01-01T00:00:00Z",
  "deployed": true
}

Safe Management

Create or Deploy a Safe (pending Setup)

deprecated

This endpoint serves two purposes - it first checks if a Safe account exists for the user. If no account exists, it creates one and initiates deployment. If an account already exists but is not deployed, it initiates the deployment process.

This endpoint can be called immediately after user signup as there are no restrictions or prerequisites.

When deploying a new Safe, the endpoint waits for transaction execution and confirmation on-chain. Because of this, the request may take up to 10 seconds to complete when a deployment is needed.

The deployment process is handled by a sponsored transaction on the Gnosis Chain, and the response includes the transaction hash for tracking the deployment status.

Next steps after successful deployment is to setup the Safe:

Once this endpoint successfully creates and deploys a Safe account, the user should call the /api/v1/safe/set-currency endpoint to set the currency for the account.
Note that the /api/v1/safe/set-currency endpoint requires the user to have completed the KYC process successfully.
Then, the user should call the /api/v1/account/signature-payload endpoint to get the signature data for the account setup.
Finally, the user should call the /api/v1/account/deploy-safe-modules endpoint to deploy the Safe modules with the user’s signature.

POST

api

account

Create or Deploy a Safe (pending Setup)

const url = 'https://api.gnosispay.com/api/v1/account';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"chainId":"100"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": "safe-account-id-123",
  "address": "0x1234567890123456789012345678901234567890",
  "userId": "user123",
  "chainId": "100",
  "salt": "some-salt-value",
  "createdAt": "2024-01-01T00:00:00Z",
  "deployed": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

chainId

enum<string>

required

The ID of chain (currently only supports Gnosis Chain)

Available options:

100

Response

Successfully created or checked Safe account

string

The Safe account ID

address

string

The Safe account address

userId

string

ID of the user owning this Safe

chainId

string

ID of the blockchain

salt

string

Salt used for Safe address generation

createdAt

string<date-time>

Timestamp of when the Safe was created

deployed

boolean

Whether the Safe is deployed on-chain

transactionHash

string

Transaction hash of the deployment transaction (if completed)

Remove account address for authentication Retrieve Signature Data for Account Setup

Authentication

API reference

PSE API

Create or Deploy a Safe (pending Setup)

Authorizations

Body

Response