Login with Password

This endpoint allows users to complete their authentication by providing their password. It is typically the second step in the login flow after /auth/login identifies the user and determines that password authentication is required.

`POST /auth/login-with-password`

Request

POST /auth/login-with-password

Headers:

{
  "Host": "api.bringyour.com",
  "Content-Type": "application/json"
}

Body:

{
  "user_auth": "user@example.com",
  "password": "your-password-here"
}

Field	Type	Description
`user_auth`	`string`	Required. The email address or phone number of the account.
`password`	`string`	Required. The user's account password.

Response

`200 Success`

Status: 200 OK

Content-Type: application/json

A successful response returns the network authentication token or indicates if multi-factor verification is required.

{
  "verification_required": {
    "user_auth": "string"
  },
  "network": {
    "by_jwt": "eyJhbGciOi...",
    "name": "string"
  },
  "error": {
    "message": "string"
  }
}

Fields

Field	Type	Description
`verification_required`	`object`	Present if the account requires a final OTP verification step.
`network`	`object`	Contains the network access token if login is complete.
`network.by_jwt`	`string`	The primary JWT for interacting with the URnetwork API.
`network.name`	`string`	The display name of the authenticated network.
`error`	`object`	Details on why the login attempt failed (e.g., invalid credentials).

Example

HTTP Request

POST /auth/login-with-password HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
 
{
  "user_auth": "support@ur.io",
  "password": "example-password"
}

Successful HTTP Response

{
  "network": {
    "by_jwt": "eyJhbGciOiJIUzI1NiI...",
    "name": "URnetwork Admin"
  },
  "error": null
}

On this page

POST /auth/login-with-password