v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

validate

The second part of login involves validating using an MFA device

An access token with PRE_AUTH authorities is required

post/v1/validate

Headers

Authorizationstring

Bearer token authorization leg of validate

Request body

otpstring required

an OTP either sent via sms or generated by a registered MFA device

Example request

{
  "otp": "123456"
}

Response

User request has been validated

access_tokenstring

Bearer token used in headers to access secure endpoints

token_typestring

the type of the token

refresh_tokenstring

can be used to obtain a new access token

expires_ininteger

The lifetime in seconds of the access token

scopestring

the scope of the access token

entityIdsstring[]

If the user is a payee then the payeeId<P> If the user is a payor then the payorId

Example response

{
  "access_token": "9b58410b-e1b7-4f90-bebb-7e09c5427020",
  "refresh_token": "c3d0f771-0997-4814-84e3-09690208545a",
  "user_info": {
    "mfa_details": {
      "mfa_type": "TOTP",
      "verified": true
    },
    "user_id": "39976ee5-dc4c-4b21-a966-a04fa71ef9e1",
    "userType": "PAYOR"
  },
  "scope": "https://api.velopayments.com/scopes/auth/users",
  "token_type": "bearer",
  "expires_in": 1800,
  "entityIds": [
    "ed89eaa0-4450-4916-a4ff-62a328d60bd6"
  ]
}