Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
password

aid_customers_mfa_login_post

Initiate a Multi-Factor Authentication for a customer user, the caller must have scope write:accounts:/auth/users to perform a login. Post the ident_type, along with the ident and secret. The server will return a challenge response specifying the challenge_type that will have to be completed to when getting an access token from the POST /v1/accounts/{oid}/auth/token endpoint. scopes:

  • write:accounts:/auth/users
post/accounts/{aid}/customers/mfa_login

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

ident_type'phone_number' | 'email' required
identstring required

Email or phone_number, depending on the ident_type.

audiencestring required

The unique identifier of the target API you want to access. The audience must be a grant associated with the client used when calling this resource.

type'customer' | 'company' required

user type to login, required as users with different type can share email

secretstring required

The customers pin or password.

Response

MFA login challenge

mfa_tokenstring required

MFA challenge token

challenge_type'oob' required

MFA challenge types

  • oob (out of band) means that the user will get an out of band message containing a binding_code that will have to be submitted along with the mfa_token when answering the mfa challenge
oob_channel'sms' | 'email'

The channel to use for OOB

Example response

{
  "links": [
    {
      "rel": "mfa_challenge",
      "href": "https://test.dintero.com/v1/accounts/T11223351/auth/mfa/challenge"
    },
    {
      "rel": "mfa_oob",
      "href": "https://test.dintero.com/v1/accounts/T11223351/auth/token"
    }
  ]
}