Applications

Applications

The Applications API lets you manage two types of broker-managed applications on behalf of your clients:

• Business Plus — For business entities. Submit the KYB form, add individuals (officers/UBOs), upload documents, and respond to asks.
• Individual Plus — For individual applicants. The applicant is the application; no separate individual management is needed.

Both types share the same detail endpoint (GET /application/detail/{id}), ask-answer endpoint, and document upload endpoint.

---

Key concepts

• ApplicationId — Returned on create. Required for every subsequent call — submit individual, upload document, answer ask, and get detail.
• ApplicationType — BUSINESS or INDIVIDUAL_PLUS. The detail response contains Business for Business applications and IndividualPlus for Individual Plus applications.
• Action items — GET /application/detail/{id} returns Form, Kyc, and Document action items. Each has a state: missing (action needed), submitted (under review), approved, or rejected.
• Async processing — KYC checks and screening run after the synchronous save. Poll detail or listen to webhooks for state changes.
• Optimistic locking — On re-submit, send the Version from the last response. A stale version returns a dirty_update (400) error.
• Locked applications — A 423 response means the application is locked. No changes are permitted until FV Bank unlocks it.

---

Business Plus workflows

Create a new Business Plus application

1. POST /application/submit-form — submit the Business KYB payload without Business.Id. Save the ApplicationId.
2. POST /application/submit-individual — add each officer/UBO. Omit Id to create.
3. POST /application/document/upload — upload required documents. Use Documents[].DocumentType from the detail response as the Type param.
4. GET /application/detail/{id} — check all action item states.

Handle a form.incomplete webhook

1. GET /application/detail/{id} — check Form state and open asks.
2. If asks exist — POST /application/ask/answer to answer each one.
3. If form data needs correction — POST /application/submit-form with Business.Id to re-submit.

Update or remove an individual

• To update — POST /application/submit-individual with the individual's Id and Version.
• To remove — DELETE /application/{applicationId}/individual/{individualId}.

---

Individual Plus workflows

Create a new Individual Plus application

1. POST /application/submit-individual-plus — submit the Individual Plus payload with Individual.Id as null. Save the ApplicationId and Id from the response.
2. POST /application/document/upload — upload required documents using Documents[].DocumentType from the detail response.
3. GET /application/detail/{id} — check all action item states.

Re-submit an Individual Plus application

1. POST /application/submit-individual-plus — include Individual.Id and Individual.Version from the last response. Send the full payload each time.

---

Common workflows (both types)

Handle a document.incomplete webhook

1. GET /application/detail/{id} — find the document with state: "missing".
2. Use Documents[].IndividualId (null = business-level, ObjectId = individual document) to set UboId on upload.
3. POST /application/document/upload — re-upload using DocumentType from the action item.

Handle a kyc.incomplete webhook

1. GET /application/detail/{id} — find the incomplete entry in the Kyc[] list.
2. Direct the individual to complete verification via the Kyc[].Link URL.