POST - Verify Step up

Completes the verification process for a step up token.

Note that on the Sandbox Environment, text messages are not sent and the verificationCode is always "123456".

End point

https://api.up.money/auth/stepup/verify-otp

Headers

Security

REQUEST BODY SCHEMA: application/json

API SECRET: x-secret

Add YWJjMTIzIQ== in x-secret in headers.

Header parameter name: x-secret

HTTP: Authorization-key

The authentication token representing the user. This will be included in the login response object as token.

Header parameter name: Authorization-key

Payload

{
    "type": "SMS", // Optional by default SMS will be used
    "verificationCode": "123456" // required
}

Sample Request

curl --location 'https://api.up2.money/auth/stepup/verify-otp' \
--header 'x-secret: YWJjMTIzIQ==' \
--header 'Authorization-key: YOUR_AUTHORIZATION_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "verificationCode": "123456" // your verification code
}'

Sample Response

No content

{
  "message": "string",
  "syntaxErrors": {
    "invalidFields": [
      {
        "params": [
          "string"
        ],
        "fieldName": "string",
        "error": "REQUIRED"
      }
    ]
  }
}

{
  "errorCode": "STATE_INVALID" // again run the step up send api
}

Response Status

204 Success - No Content.

400 Bad Request Error - Your request is invalid.

errorCode: Enum: "REQUIRED" "HAS_TEXT" "REQUIRES" "SIZE" "RANGE" "IN" "NOT_IN" "REGEX" "EXACTLY" "AT_LEAST" "AT_MOST" "ALL_OR_NONE"

401 Unauthorized - Your credentials or access token are invalid.

403 Forbidden - Access to the requested resource or action is forbidden.

404 Not found - The requested resource couldn't be found.

405 Method Not Allowed - The request was received but has been rejected for the requested resource.

409 Conflict

errorCode: Enum: "STATE_INVALID" "VERIFICATION_CODE_EXPIRED" "VERIFICATION_CODE_INVALID" "CHANNEL_NOT_SUPPORTED" "CHANNEL_NOT_REGISTERED"

429 Too many requests.

500 Internal Server Error - There is a problem with the server. Please try again later.

503 Service Unavailable - We're temporarily offline for maintenance. Please try again later.

Last updated 1 year ago

curl --location 'https://api.up2.money/auth/stepup/verify-otp' \ --header 'x-secret: YWJjMTIzIQ==' \ --header 'Authorization-key: YOUR_AUTHORIZATION_KEY' \ --header 'Content-Type: application/json' \ --data '{ "verificationCode": "123456" // your verification code }'

{ "message": "string", "syntaxErrors": { "invalidFields": [ { "params": [ "string" ], "fieldName": "string", "error": "REQUIRED" } ] } }