Save a login

curl --request POST \
  --url https://api.pomerado.ai/v1/logins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site_url": "<string>",
  "label": "<string>",
  "username": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "account_number": "<string>",
  "password": "<string>",
  "date_of_birth": "<string>",
  "zip": "<string>",
  "authenticator_secret": "<string>",
  "recovery_codes": [
    "<string>"
  ],
  "deliver": "dashboard"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    site_url: '<string>',
    label: '<string>',
    username: '<string>',
    email: '<string>',
    phone: '<string>',
    account_number: '<string>',
    password: '<string>',
    date_of_birth: '<string>',
    zip: '<string>',
    authenticator_secret: '<string>',
    recovery_codes: ['<string>'],
    deliver: 'dashboard'
  })
};

fetch('https://api.pomerado.ai/v1/logins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pomerado.ai/v1/logins"

payload = {
    "site_url": "<string>",
    "label": "<string>",
    "username": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "account_number": "<string>",
    "password": "<string>",
    "date_of_birth": "<string>",
    "zip": "<string>",
    "authenticator_secret": "<string>",
    "recovery_codes": ["<string>"],
    "deliver": "dashboard"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dashboard_url": "<string>"
}

{
  "id": "login_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "label": "<string>",
  "site": {
    "url": "<string>",
    "name": "<string>"
  },
  "username_masked": "<string>",
  "identifier_type": "username",
  "sign_in": "password",
  "saved_fields": [
    "email"
  ],
  "two_factor": {
    "authenticator": true,
    "sms_number": "none"
  },
  "status": "unverified",
  "needs_attention": {
    "field": "username"
  },
  "locked": true,
  "your_access": "use",
  "created_at": "<string>",
  "updated_at": "<string>",
  "verified_at": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

POST

logins

Save a login

curl --request POST \
  --url https://api.pomerado.ai/v1/logins \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "site_url": "<string>",
  "label": "<string>",
  "username": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "account_number": "<string>",
  "password": "<string>",
  "date_of_birth": "<string>",
  "zip": "<string>",
  "authenticator_secret": "<string>",
  "recovery_codes": [
    "<string>"
  ],
  "deliver": "dashboard"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    site_url: '<string>',
    label: '<string>',
    username: '<string>',
    email: '<string>',
    phone: '<string>',
    account_number: '<string>',
    password: '<string>',
    date_of_birth: '<string>',
    zip: '<string>',
    authenticator_secret: '<string>',
    recovery_codes: ['<string>'],
    deliver: 'dashboard'
  })
};

fetch('https://api.pomerado.ai/v1/logins', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pomerado.ai/v1/logins"

payload = {
    "site_url": "<string>",
    "label": "<string>",
    "username": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "account_number": "<string>",
    "password": "<string>",
    "date_of_birth": "<string>",
    "zip": "<string>",
    "authenticator_secret": "<string>",
    "recovery_codes": ["<string>"],
    "deliver": "dashboard"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dashboard_url": "<string>"
}

{
  "id": "login_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "label": "<string>",
  "site": {
    "url": "<string>",
    "name": "<string>"
  },
  "username_masked": "<string>",
  "identifier_type": "username",
  "sign_in": "password",
  "saved_fields": [
    "email"
  ],
  "two_factor": {
    "authenticator": true,
    "sms_number": "none"
  },
  "status": "unverified",
  "needs_attention": {
    "field": "username"
  },
  "locked": true,
  "your_access": "use",
  "created_at": "<string>",
  "updated_at": "<string>",
  "verified_at": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "docs_url": "<string>",
    "details": {}
  }
}

Details

The values pass through this client and its model provider. Warn the user first, or send deliver “dashboard” with only site_url and label to get a Dashboard link where the person enters the login instead.
A Personal account keeps one login per website, fixed to its identity after the first verified sign-in. A Business account may save several.
Callers: an API key, an MCP OAuth token or a Dashboard session.
Permission: logins:manage.
Effect: Creates or changes something.
Errors: site_not_supported, site_login_exists, login_identity_conflict, legacy_duplicate_saved_logins, saved_login_unsettled, login_in_use, login_save_in_progress, invalid_credential, acceptance_unknown, and the errors any request can get.

Authorizations

Authorization

string

header

required

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

Body

application/json

site_url

string

required

The website, such as instacart.com or a pasted URL, saved as its HTTPS origin

Maximum string length: 2048

label

string

a string at most 200 character(s) long

Required string length: 1 - 200

username

string

a string at most 1024 character(s) long

Required string length: 1 - 1024

string

a string at most 320 character(s) long

Required string length: 3 - 320

phone

string

a string at most 64 character(s) long

Required string length: 3 - 64

account_number

string

a string at most 128 character(s) long

Required string length: 1 - 128

primary_identifier

enum<string>

The identifier it signs in with; else the first it holds in this order

Available options:

username,

email,

phone,

account_number

password

string

a string at most 16384 character(s) long

Required string length: 1 - 16384

code: the site sends a code each sign-in, so no password is saved

Available options:

password,

code

date_of_birth

string

a string matching the pattern ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

zip

string

a string at most 10 character(s) long

Required string length: 3 - 10

authenticator_secret

string

a string at most 4096 character(s) long

Required string length: 1 - 4096

recovery_codes

string[]

an array of at most 20 item(s)

Required array length: 1 - 20 elements

a string at most 64 character(s) long

Required string length: 4 - 64

preferred_method

enum<string>

A two-factor method

Available options:

sms,

call,

email,

authenticator,

push,

recovery_code

deliver

enum<string>

Return a Dashboard link where the person enters the login, so no secret reaches this client

Available options:

dashboard

Response

With deliver dashboard: where to finish

dashboard_url

string

required

A signed-in Dashboard page where the person finishes this and sees the secret once

Overview

Account

Runs

Builds

Jobs

Tools and integrations

Files

Webhooks

Saved logins

2FA

Login access

Team

API keys

Connected apps

Usage and quota

Billing

Save a login

Authorizations

Body

Response