Follow this guide to have an application validated using the Application Boarding API resource. This request checks and validates all data fields in the application, including dependencies they may have between each other. An application may not be submitted until it passes validation. See Validate Application in API Reference for field definitions.

Prerequisites

1. Contact Maast to set up your Maast Partner account.
2. Follow the steps in Get Your API Credentials to save your vendor sandbox ID and API key.
3. See Authentication to format the credentials and generate your API token. (Alternatively, use the credentials as-is to test this endpoint with our 'Try It!' feature.)
4. Use the Create Application guide to generate an application and save its application ID (appid).
5. Optionally, fill some or all of the application by sending Save Data and/or Upload Document requests.

Implement

Write a GET request. For the request endpoint, include the application's ID (appid) between /application/ and /validate. The resulting endpoint reads /platform/application/{appId}/validate, where the ID replaces {appId}.

Your complete request will resemble the sample code below:

curl --request GET \
     --url https://api-test.maast.com/platform/application/119146/validate \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZGVjMjFhMzFjMHh5ejc4OWUzMGEzNDE2YWJjMTIz'

Integrate

Send your request. If the application is successfully validated, you will receive a response like this from the Maast server:

{
  "code": 0,
  "message": "Success"
}

If the application is incomplete, the remaining required fields are listed in the data object of the response, as below:

{
  "code": 2,
  "message": "Request validation failed",
  "data": {
    "fulfillment_provider_flag": [
      "Field is required."
    ],
    "total_volume": [
      "Field is required."
    ],
    "bank_account_number": [
      "Bank account and routing number are required."
    ]
  }
}

Check the code field in the request response: 0 confirms that you have successfully validated the application. If the value is something other than 0, check Platform API Response Codes in Reference.

See Validate Application in API Reference for response field definitions. Check your Create Application or Get Application response for accepted and required fields.

Test and Go Live

See our Test and Go Live guide to test your API integration and to start transacting with an active production account.