Sign Up

Sequence Diagram

Code Sample

import EthCrypto from 'eth-crypto';
import axios from 'axios';

const baseURL = 'https://dev-testnet.wallaby.cash/api/v1';

try {
  // User identifier from the republic
  const externalUserId = 'c0ac5037-e425-4a41-a20e-adf85e93bfa6';

  // 1. Generate the key pair
  const { publicKey, privateKey } = EthCrypto.createIdentity();
  const apiKey = '071b51027b264a1b8fcd3d73684d25ca'

  // 2. Request for the message to be signed
  const {
    data: { message },
  } = await axios.post(`${baseURL}/auth/signature-message`, {
    publicKey,
  }, {
    headers: {
      'X-API-KEY': apikey,
    }
  });

  // 3. Sign the message
  const hashedMessage = EthCrypto.hash.keccak256(message);
  const signature = EthCrypto.sign(privateKey, hashedMessage);

  // 4. Send the signature to the server to sign up
  const {
    data: { user, accessToken },
  } = await axios.post(`${baseURL}/auth/sign-up`, {
    publicKey,
    signature,
    message,
    externalUserId,
  }, {
    headers: {
      'X-API-KEY': apikey,
    }
  });

  console.log(user, accessToken);
} catch (error) {
  console.log(error?.response || error?.message);
}

Relevant APIs

The returned message will be used for sign up and sign in signature

post

Authorizations

Body

clientAuthPubKeystringRequired

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/auth/signature-message HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "clientAuthPubKey": "text"
}

200

Message retrieved successfully

{
  "message": "text"
}

Users will be able to sign up by providing a signature and message. Message to sign can be retrieved from /api/auth/signature-message

post

Authorizations

Body

messagestringRequired

Message retrieved from the backend

Example: 717ea458b62a430cb37ced7c22ebec97

clientAuthPubKeystringRequiredExample: e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc

signaturestringRequired

Signature generated after signing the provided data field

Example: 0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c

externalUserIdstringRequired

Client's User ID in UUID format

Example: 6e464058-67c1-4273-a6a4-8aae522e34be

firstNamestringRequired

User's First Name from the Republic

Example: First Name

lastNamestringRequired

User's Last Name from the Republic

Example: Last Name

merchantIdstringOptionalExample: 6e464058-67c1-4273-a6a4-8aae522e34be

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/auth/sign-up HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 499

{
  "message": "717ea458b62a430cb37ced7c22ebec97",
  "clientAuthPubKey": "e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc",
  "signature": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c",
  "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
  "firstName": "First Name",
  "lastName": "Last Name",
  "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be"
}

{
  "accessToken": "text",
  "user": {
    "id": "5768ad09-665c-475e-8d90-3e4dcbd296e3",
    "firstName": "First Name",
    "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
    "clientAuthPubKey": "e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc",
    "wallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
    "wallabyAuthPubKeyVersion": "1",
    "role": "wallet_user"
  }
}