Add an application to a profile (API)

This developer guide takes you through the steps to add an application to a profile in the PassFort API 4.0.

If a profile’s already created, follow these steps to add an application to it.

To save time, instead of creating the profile with one call to the API and adding the application as a second call, you can create a profile and add add application to it using a single call to the API.

1. Select a profile

You can add applications to profiles with the INDIVIDUAL or COMPANY type.

Choose any profile to add the application to, and get the profile's ID number (e.g. a2c4393a-e219-67a4-5ab4-2186952e9038). You'll need it to make the request in the next step.

If you haven't created the profile yet, follow these steps to create one via the API.
You can also create a profile via the portal. To get the profile ID, view the profile in the portal and copy the string of letters and numbers after /onboarding/ in the URL.

2. Add the application

To add the application, make a request to the following endpoint.

Request endpoint:

POST https://api.passfort.com/4.0/profiles/{profile_id}/applications

Body parameters:

When you make the request, include the following parameters in the body.

Key

Value

Description

product

Required

Object

See the sample request body below for a sample value.

Object that defines the product.

product.alias

Required

This key is Optional if product.id is provided, but we recommend sending product.alias whenever possible.

String

Sample value:

forexo_basic

The product's alias.

product.id

Required

This key is Optional if product.alias is provided.

We recommend sending product.alias instead of product.id whenever possible.

String

Sample value:

6cceb65e-d86b-11e9-b8b6-7a5deda3a0a3

The unique identifier for the product.

associated_role

Optional

String

AUTHORIZED_PERSON,

UNAUTHORIZED_PERSON,

DIRECTOR,

COMPANY_SECRETARY,

SHAREHOLDER,

PARTNER,

TRUSTEE,

BENEFICIAL_OWNER,

RESIGNED_OFFICER, or

OTHER

This is the company associate's role.

It's only used when the application is for a company associate.

In this example, an application for a product called Forexo Basic Account is added to a profile.

Sample request body:

{
"product": {
"alias": "forexo_basic"
}
}
If you're copying this sample request for your own testing, remember to replace forexo_basic with your own product alias.

Sample response:

{
"approval_blockers": [ ... ],
"assignments": [ ],
"flag": "AUTOMATING",
"flag_history": [ ... ],
"hidden": false,
"history": [ ... ],
"id": "edc23993-eb6a-9d89-bb79-5b8925b33224",
"product": {
"alias": "forexo_basic",
"automatically_approve": false,
"id": "b0ce7c17-2cab-86e7-9a83-ebee0d4d5dc8",
"name": "Forexo Basic Account"
},
"required_tasks": [
{
"id": "3d7a333c-418d-72a1-007b-06854dbb28eb",
"task_type": "INDIVIDUAL_VERIFY_IDENTITY"
}
],
"status": "APPLIED"
}

When a product application is added to a profile, some important keys are created automatically, which you can see in the response:

  • id: The profile's product application ID. It is unique to this profile's application.
  • product: An object containing information about the product that the application is for. The information it contains will be the same for every profile that's made an application to this product.
  • status: The current status of the application. Learn more about application statuses.
  • required_tasks: An array of objects where every object corresponds to a task that needs to be completed before the application can be approved.
  • flag: This field tells you how to progress the application to the next state. Although several actions may be taken to progress the application, only one flag is returned at a time so you know which action to act on. Learn more about application flags.

To learn more about the lifecycle of an application, see Manage product applications.


How did we do?


Powered by HelpDocs