Create Onboarding Web API

Introduction

Copy link to clipboard

The Create Onboarding web API allows third-party applications, such as CRMs, to push information to the Appian Connected Onboarding solution. This information can then be used to automatically kick off an onboarding.

This page provides definitions for the Create Onboarding web API that is available with the baseline Connected Onboarding solution, as well as instructions for how to access the web API via a service account.

Provisioning web API access for external systems

Copy link to clipboard

Each web API provided with the Connected Onboarding solution contains its own viewer group. The viewer group for each API is specified below:

To provision an account for an external system to access a web API:

1. Create a new user account in the Appian Admin Console for each external system that will access a web API.
2. Give this user the Service Account Role by adding them to the Service Accounts group in Appian Designer.
3. To access the web API via an API key instead of via Basic Authentication, create an API key for this user account in the Admin Console.
4. Place this user in one or more of the web API viewer groups listed above to give this user account access to call the web API.

Create Onboarding web API

Copy link to clipboard

Use this web API to create a new onboarding request for an existing customer record.

• Method: POST
• Endpoint: io-onboardings
• Viewer Group: AS IO WA POST Onboardings
• Web API Object Name: AS IO WA POST Onboardings

Sample Request

Copy link to clipboard

Request

1
POST https://<URL>/suite/webapi/io-onboardings/v1?sysCode=SF
Copy

Input Data

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  {
  "estValueCurrencyCode":"DOP",
  "estFundingValue":1000,
  "estFundingDate":"2021-10-06Z",
  "type":"ONBOARDING_TYPE_CAPITAL_MARKETS_BUY_SIDE",
  "customer": 
    { "customerId":"1" },
  "product":
    { "productTypeCode":"PRODUCT_TYPE_SECURED_LOANS",
      /*Optional Fields*/
       "name":"",
       "actualValueCurrencyCode":"",
       "actualFundingValue":null
    } 
}
Copy

Query Parameters

Copy link to clipboard

• sysCode - The code of the external system (required)

Body Fields

Copy link to clipboard

• type - The type of onboarding request; from the CODE column in the AS_IO_R_DATA table for type Onboarding Type.
• customer - The related customer for the onboarding request (required).
  • customerId - The Appian ID (primary key) of the customer entity from the CUSTOMER_ID column of the AS_FS_CUSTOMER table.
• priorityCode - The priority of the onboarding request (optional).
• actualValueCurrencyCode - The currency code for the actual funding value (optional).
• actualFundingValue - The value of the actual funding (optional).
• actualFundingDate - The actual funding date (optional).
• estValueCurrencyCode - The currency code for the estimated funding value (optional).
• estFundingValue - The estimated funding value (optional).
• estFundingDate - The date of the estimated funding (optional).
• description - The additional description (optional).

Sample Response

Copy link to clipboard

1
2
3
4
5
6
7
{
   "statusCode":200,
   "body":{
      "onboardingId":44,
      "onboardingUrl":"https://...suite/site/records..."
   }
}
Copy

Response Fields

Copy link to clipboard

• onboardingId - The Appian ID of the created onboarding request.
• onboardingUrl - The URL of the created onboarding request record.

Feedback

Copy link to clipboard