Log in with email and password

curl --request POST \
  --url https://app.sure.am/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "password": "<string>",
  "device": {
    "device_id": "<string>",
    "device_name": "<string>",
    "device_type": "<string>",
    "os_version": "<string>",
    "app_version": "<string>"
  },
  "otp_code": "<string>"
}
'

import requests

url = "https://app.sure.am/api/v1/auth/login"

payload = {
    "email": "jsmith@example.com",
    "password": "<string>",
    "device": {
        "device_id": "<string>",
        "device_name": "<string>",
        "device_type": "<string>",
        "os_version": "<string>",
        "app_version": "<string>"
    },
    "otp_code": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jsmith@example.com',
    password: '<string>',
    device: {
      device_id: '<string>',
      device_name: '<string>',
      device_type: '<string>',
      os_version: '<string>',
      app_version: '<string>'
    },
    otp_code: '<string>'
  })
};

fetch('https://app.sure.am/api/v1/auth/login', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sure.am/api/v1/auth/login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com',
    'password' => '<string>',
    'device' => [
        'device_id' => '<string>',
        'device_name' => '<string>',
        'device_type' => '<string>',
        'os_version' => '<string>',
        'app_version' => '<string>'
    ],
    'otp_code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.sure.am/api/v1/auth/login"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"device\": {\n    \"device_id\": \"<string>\",\n    \"device_name\": \"<string>\",\n    \"device_type\": \"<string>\",\n    \"os_version\": \"<string>\",\n    \"app_version\": \"<string>\"\n  },\n  \"otp_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sure.am/api/v1/auth/login")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"device\": {\n    \"device_id\": \"<string>\",\n    \"device_name\": \"<string>\",\n    \"device_type\": \"<string>\",\n    \"os_version\": \"<string>\",\n    \"app_version\": \"<string>\"\n  },\n  \"otp_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/auth/login")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"device\": {\n    \"device_id\": \"<string>\",\n    \"device_name\": \"<string>\",\n    \"device_type\": \"<string>\",\n    \"os_version\": \"<string>\",\n    \"app_version\": \"<string>\"\n  },\n  \"otp_code\": \"<string>\"\n}"

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

{
  "access_token": "<string>",
  "refresh_token": "<string>",
  "token_type": "<string>",
  "expires_in": 123,
  "created_at": 123,
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "ui_layout": "dashboard",
    "ai_enabled": true
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

POST

api

auth

curl --request POST \
  --url https://app.sure.am/api/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "password": "<string>",
  "device": {
    "device_id": "<string>",
    "device_name": "<string>",
    "device_type": "<string>",
    "os_version": "<string>",
    "app_version": "<string>"
  },
  "otp_code": "<string>"
}
'

import requests

url = "https://app.sure.am/api/v1/auth/login"

payload = {
    "email": "jsmith@example.com",
    "password": "<string>",
    "device": {
        "device_id": "<string>",
        "device_name": "<string>",
        "device_type": "<string>",
        "os_version": "<string>",
        "app_version": "<string>"
    },
    "otp_code": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jsmith@example.com',
    password: '<string>',
    device: {
      device_id: '<string>',
      device_name: '<string>',
      device_type: '<string>',
      os_version: '<string>',
      app_version: '<string>'
    },
    otp_code: '<string>'
  })
};

fetch('https://app.sure.am/api/v1/auth/login', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sure.am/api/v1/auth/login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com',
    'password' => '<string>',
    'device' => [
        'device_id' => '<string>',
        'device_name' => '<string>',
        'device_type' => '<string>',
        'os_version' => '<string>',
        'app_version' => '<string>'
    ],
    'otp_code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.sure.am/api/v1/auth/login"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"device\": {\n    \"device_id\": \"<string>\",\n    \"device_name\": \"<string>\",\n    \"device_type\": \"<string>\",\n    \"os_version\": \"<string>\",\n    \"app_version\": \"<string>\"\n  },\n  \"otp_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sure.am/api/v1/auth/login")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"device\": {\n    \"device_id\": \"<string>\",\n    \"device_name\": \"<string>\",\n    \"device_type\": \"<string>\",\n    \"os_version\": \"<string>\",\n    \"app_version\": \"<string>\"\n  },\n  \"otp_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/auth/login")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"device\": {\n    \"device_id\": \"<string>\",\n    \"device_name\": \"<string>\",\n    \"device_type\": \"<string>\",\n    \"os_version\": \"<string>\",\n    \"app_version\": \"<string>\"\n  },\n  \"otp_code\": \"<string>\"\n}"

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

{
  "access_token": "<string>",
  "refresh_token": "<string>",
  "token_type": "<string>",
  "expires_in": 123,
  "created_at": 123,
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "ui_layout": "dashboard",
    "ai_enabled": true
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Body

application/json

string<email>

required

password

string

required

device

object

required

Show child attributes

otp_code

string | null

TOTP code if MFA is enabled

Response

access_token

string

refresh_token

string

token_type

string

expires_in

integer

created_at

integer

user

object

Show child attributes

⌘I

Auth

Accounts

Balance Sheet

Balances

Budget Categories

Budgets

Categories

Chats

Family Exports

Family Settings

Holdings

Import Sessions

Imports

Merchants

Provider Connections

Recurring Transactions

Rejected Transfers

Rule Runs

Rules

Securities

Security Prices

Sync

Tags

Trades

Transactions

Transfers

Valuations

Users

Log in with email and password

Body

Response