Skip to navigation

Identity Check Request

View as Markdown

Run the identity check for a customer application.

Available to: Approved business-to-business account-opening partners

Environments: Live

Run the required identity check after submitting the applicant details with submitApplicant and before preparing the account agreements.

Provide customerApplication.id from the startCustomerApplication response as customerApplicationId. The response reports the identity-check result and can include follow-up questions and a journeyApplicationToken.

Identity-Verification Rollout Option

isDarkLaunchEnabled is an optional boolean for the primary applicant’s supported identity-verification journey:

ValueBehavior
trueRequests the configured rollout journey version, when one is configured. Enable this option only as directed by NinjaTrader during rollout onboarding.
false or omittedSends no journey-version override. Leave the field unset for the standard integration unless NinjaTrader instructs you otherwise.

This option doesn’t select the verification provider and doesn’t apply to joint-applicant checks. It doesn’t bypass identity verification or indicate that the application is approved.

A ReviewNeeded result means the application requires review; it does not mean the application is approved. Continue with the agreement flow, then track the application to a final status with customerApplicationItem.

Questionnaire submission is outside this guide’s partner API scope. If the response includes follow-up questions or a journey token, preserve the data with the application and coordinate the next steps with your NinjaTrader onboarding contact. Don’t attempt an undocumented questionnaire-submission call.

Next Steps

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
customerApplicationIdlongRequired
iovationBlackboxstringOptional<=8192 characters
isDarkLaunchEnabledbooleanOptional

For the primary applicant’s supported identity-verification journey, true requests the configured rollout version. If false or omitted, no journey-version override is sent. Enable only as directed by NinjaTrader.

Response

IdentityCheckResponse
questionslist of objects
errorTextstringOptional<=8192 characters

Non-empty if the request failed

resultenumOptional
Fail, Pass, ReviewNeeded
Allowed values:
journeyApplicationTokenstringOptional<=64 characters