Get Applications

Error

A valid request URL is required to generate request examples

{
  "applications": [
    {
      "id": "<string>",
      "status": "KYC",
      "user": {
        "id": "8E13_EWEF5a9GuatLqwm5eD6kQRFloKKxIkHM14YiIbkrxpfSNft8_-AyiMUmZHkd-zp7qrhiJITsCBlOeJ4db0NOfG5kas5QDcVR1cxU36EGwaxcgB0Qk4xgj-ViS-TMw==",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@mail.com",
        "phone_number": "+14155552671",
        "middle_name": "Garrett",
        "date_of_birth": {
          "day": 1,
          "month": 1,
          "year": 1980
        },
        "place_of_birth": {
          "city": "San Francisco",
          "region": "CA",
          "country_iso2": "US"
        },
        "country_iso2": "US",
        "signup_date": "2021-09-01T12:00:00Z"
      },
      "created_on": "2021-09-01T12:00:00Z",
      "updated_on": "2021-09-01T12:00:00Z",
      "kyc_url": "https://bank-partner/kyc_webview?user_id=8E13_EWEF5a9GuatLqwm5eD6kQRFloKKxIkHM14YiIbkrxpfSNft8_-AyiMUmZHkd-zp7qrhiJITsCBlOeJ4db0NOfG5kas5QDcVR1cxU36EGwaxcgB0Qk4xgj-ViS-TMw==",
      "national_id": {
        "id": "419550000",
        "type": "SSN",
        "issuer_country_iso2": "US",
        "additional_national_ids": [
          {
            "id": "419550000",
            "type": "SSN",
            "issuer_country_iso2": "US"
          }
        ]
      },
      "address": {
        "address": "Elm Street",
        "city": "San Francisco",
        "postal_code": "94110",
        "address2": "Mission District",
        "street_number": "5678",
        "unit": "2A",
        "neighborhood": "Dolores Heights",
        "region": "CA",
        "country_iso2": "US"
      },
      "shipping_address": {
        "address": "Elm Street",
        "city": "San Francisco",
        "postal_code": "94110",
        "address2": "Mission District",
        "street_number": "5678",
        "unit": "2A",
        "neighborhood": "Dolores Heights",
        "region": "CA",
        "country_iso2": "US"
      },
      "tax_profile": {
        "organization_name": "Acme Corp.",
        "jurisdiction_country_iso2": "US",
        "tin": "NL123456789B12",
        "no_tin_reason": "<string>",
        "citizenships": [
          "US"
        ],
        "additional_tax_residencies": [
          {
            "jurisdiction_country_iso2": "US",
            "tin": "NL123456789B12",
            "no_tin_reason": "<string>"
          }
        ]
      },
      "financial_profile": {
        "account_purpose": "Business expenses",
        "source_of_funds": {
          "funds_origin": "Uber and Gig-economy platforms",
          "primary_source": "Revenue from self-employment"
        }
      },
      "terms": [
        {
          "name": "<string>",
          "accepted": true,
          "accepted_on": "2023-11-07T05:31:56Z"
        }
      ],
      "device": {
        "id": "f3402095-26be-4d34-b263-ab665470295a",
        "model": "SM-A156U",
        "os_name": "android",
        "os_version": "14"
      },
      "extras": {}
    }
  ],
  "next_cursor": "eyJpZCI6IjEyMyJ9"
}

{
  "reason": {
    "message": "<string>"
  },
  "extras": {}
}

GET

applications

Error

A valid request URL is required to generate request examples

{
  "applications": [
    {
      "id": "<string>",
      "status": "KYC",
      "user": {
        "id": "8E13_EWEF5a9GuatLqwm5eD6kQRFloKKxIkHM14YiIbkrxpfSNft8_-AyiMUmZHkd-zp7qrhiJITsCBlOeJ4db0NOfG5kas5QDcVR1cxU36EGwaxcgB0Qk4xgj-ViS-TMw==",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@mail.com",
        "phone_number": "+14155552671",
        "middle_name": "Garrett",
        "date_of_birth": {
          "day": 1,
          "month": 1,
          "year": 1980
        },
        "place_of_birth": {
          "city": "San Francisco",
          "region": "CA",
          "country_iso2": "US"
        },
        "country_iso2": "US",
        "signup_date": "2021-09-01T12:00:00Z"
      },
      "created_on": "2021-09-01T12:00:00Z",
      "updated_on": "2021-09-01T12:00:00Z",
      "kyc_url": "https://bank-partner/kyc_webview?user_id=8E13_EWEF5a9GuatLqwm5eD6kQRFloKKxIkHM14YiIbkrxpfSNft8_-AyiMUmZHkd-zp7qrhiJITsCBlOeJ4db0NOfG5kas5QDcVR1cxU36EGwaxcgB0Qk4xgj-ViS-TMw==",
      "national_id": {
        "id": "419550000",
        "type": "SSN",
        "issuer_country_iso2": "US",
        "additional_national_ids": [
          {
            "id": "419550000",
            "type": "SSN",
            "issuer_country_iso2": "US"
          }
        ]
      },
      "address": {
        "address": "Elm Street",
        "city": "San Francisco",
        "postal_code": "94110",
        "address2": "Mission District",
        "street_number": "5678",
        "unit": "2A",
        "neighborhood": "Dolores Heights",
        "region": "CA",
        "country_iso2": "US"
      },
      "shipping_address": {
        "address": "Elm Street",
        "city": "San Francisco",
        "postal_code": "94110",
        "address2": "Mission District",
        "street_number": "5678",
        "unit": "2A",
        "neighborhood": "Dolores Heights",
        "region": "CA",
        "country_iso2": "US"
      },
      "tax_profile": {
        "organization_name": "Acme Corp.",
        "jurisdiction_country_iso2": "US",
        "tin": "NL123456789B12",
        "no_tin_reason": "<string>",
        "citizenships": [
          "US"
        ],
        "additional_tax_residencies": [
          {
            "jurisdiction_country_iso2": "US",
            "tin": "NL123456789B12",
            "no_tin_reason": "<string>"
          }
        ]
      },
      "financial_profile": {
        "account_purpose": "Business expenses",
        "source_of_funds": {
          "funds_origin": "Uber and Gig-economy platforms",
          "primary_source": "Revenue from self-employment"
        }
      },
      "terms": [
        {
          "name": "<string>",
          "accepted": true,
          "accepted_on": "2023-11-07T05:31:56Z"
        }
      ],
      "device": {
        "id": "f3402095-26be-4d34-b263-ab665470295a",
        "model": "SM-A156U",
        "os_name": "android",
        "os_version": "14"
      },
      "extras": {}
    }
  ],
  "next_cursor": "eyJpZCI6IjEyMyJ9"
}

{
  "reason": {
    "message": "<string>"
  },
  "extras": {}
}

Use this endpoint to check whether a user already has an application in progress or has already been onboarded, before you start a new White Label App (WLA) onboarding flow. Send a GET request to /applications with the user’s ID; the response includes every application submitted for that user, ordered by created_on in ascending order. Reasons to call this endpoint include:

Resuming an interrupted signup: Check for an existing application in the KYC status before redirecting the applicant to start over, then reuse the kyc_url from that application instead of submitting a duplicate.
Displaying application status in your app: Poll this endpoint to show the applicant where they stand, as a fallback for cases where you cannot process outbound application events.
Preventing duplicate submissions: Check for any non-final application (SUBMITTED, KYC, or MANUAL_REVIEW) for the user before you submit a new one.

Set active_only to false if you also need to see applications in a final status, such as APPROVED, REJECTED, or EXPIRED.

If the specified user has no applications, the response returns an empty applications array rather than an error.

If the user has more applications than fit in a single page, use the next_cursor value from the response as the cursor parameter in your next request to page through the rest.

Authorizations

Authorization

string

header

required

Token used to verify user identity and also authorize user to use service.

Query Parameters

user_id

string

required

Partner-provided user ID to filter applications by.

active_only

boolean

default:true

Indicate if only active applications should be returned. An active application is one that has a status other than APPROVED, REJECTED, or EXPIRED.

limit

integer

Maximum number of items to return. If not present, no limit should be applied.

Required range: 1 <= x <= 100

cursor

string

Cursor to a specific position in the results. If not present, the first page should be returned.

Example:

"eyJpZCI6IjEyMyJ9"

Response

Successful operation

applications

object[]

required

The list of active applications for the user.

Show child attributes

next_cursor

string

Cursor to fetch the next results.

Example:

"eyJpZCI6IjEyMyJ9"

⌘I

Core API Basics

SDKs

White Label App

Credentials

Account Holders

Funding

Just-in-Time Funding

Cards

Digital Wallets

Spend Control

Accounts

Transactions

3D Secure

Real-Time Decisioning

Disputes

Digital Banking

Credit Programs

Credit Account Management

Credit Account Servicing

Credit Reward Accounts

Testing

Webhooks

Authorizations

Query Parameters

Response