Skip to main content
POST
Simulate the compliance verdict on a sandbox application

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required
Example:

"app_1A2b3C4d5E6f7G8h9I0jKl"

Body

application/json
outcome
enum<string>
required

Decision to force onto the application. approved activates the resource it produces; rejected records a rejection.

Available options:
approved,
rejected
reason
string

Free-text rejection reason. Valid on the free-text branch ({ outcome: "rejected", reason }) and on category: generic. Persisted verbatim to rejectionReason.

Maximum string length: 500
category
enum<string>

Structured rejection category, not case-sensitive. Selects a specific user-facing summary. Mutually exclusive with a bare reason on non-generic branches.

Available options:
document_mismatch,
data_sourcing_mismatch,
compliance,
generic
field
string

Optional field hint. Requires category; sending field without category yields 400 VALIDATION_ERROR. Accepted by document_mismatch (tax_id / date_of_incorporation / business_name / business_entity_id, and for an individual application's own fields account_holder_birth_date / account_holder_address / account_holder_tax_id) and data_sourcing_mismatch (business_entity_id / ubo_first_name / ubo_last_name / ubo_phone / ubo_email / ownership_list; on an individual application the ubo_* fields point at the account holder). Rejected on other categories and on the free-text branch.

Response

The application at its new terminal state

id
string
required

Unique application identifier

Pattern: ^app_[0-9A-Za-z]{22}$
status
enum<string>
required

Current lifecycle status of the application

Available options:
pending,
processing,
approved,
rejected,
cancelled
Example:

"pending"

createdAt
string<date-time>
required

Timestamp when the application was created

Example:

"2026-01-15T09:30:00.000Z"

updatedAt
string<date-time>
required

Timestamp when the application was last modified

Example:

"2026-01-15T09:30:00.000Z"

type
enum<string>
required
Available options:
customer_onboarding
clientReferenceId
string

Client-provided identifier for cross-referencing. Omitted when the client did not supply one. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$
Example:

"ext-12345"

submittedAt
string<date-time>

Timestamp when the application was submitted for review. Omitted while still in progress.

Example:

"2026-01-15T09:30:00.000Z"

failureCode
enum<string>

Machine-readable failure code on rejected applications. Omitted on non-rejected applications.

Available options:
rejected_by_ops,
compliance_denied
failureMessage
string

Customer-facing failure message accompanying failureCode. Omitted on non-rejected applications.

resubmittable
boolean

Whether a corrected application will be considered. true: correct the data and submit a fresh application. false: the decision is final, do not resubmit. Omitted on non-rejected applications.

reviewStage
enum<string>

Where the review of a processing application stands. automated: Conduit's automated review is still running. operator: the automated review finished without a decision, or Conduit has an open request for information about the application. A Conduit operator owns the next step unless the request needs your answer. operator means no automated decision will come; expect a decision or a request for information from Conduit. Present only while status is processing.

Available options:
automated,
operator
customerId
string

Customer this onboarding application produced. Omitted while the application is still being reviewed; present after approval persists the customer row.

Pattern: ^cus_[0-9A-Za-z]{22}$
persons
object[]

People declared on the submission, in submit order: the owners, controlling persons and legal representatives of a business, or the one account holder of an individual. Omitted before the application carries a submission.

resubmissionGuidance
string

Integrator guidance for the resubmission. Present only on a rejected application whose resubmittable is true. A fixed line — display or log it, do not parse it. Omitted on non-rejected applications and on final rejections.

reviewQuestions
string[]

Questions to address in the resubmission. Present only on a rejected application whose resubmittable is true when Conduit asks for more information. Omitted otherwise.