IDentityFirst IDentity integration

From first request
to a result you can use.

Connect your sandbox, submit a capture, and receive the result on your server. One path through the complete IDentity integration.

IDentitySandboxAPI integration pathUsing ONBO 2.0? →

How the pieces connect

The result returns to your server. A browser callback and a server webhook are separate integration surfaces.

01ACCOUNT / SERVER

Prepare your sandbox

Start with credentials for the right environment.

Obtain access to the IDentity Portal. From Downloads, generate Sandbox Testing Credentials. Choose the service your integration needs before building its request.

Need portal access? Contact Customer Success.

Expected outcome

You have sandbox credentials and the input schema for your selected service.

Read the setup guide →
Something not working?

Missing access? Contact your IDmission customer success team.

Troubleshoot IDentity →
02YOUR BACKEND

Connect your integration

Keep credentials on your server.

Use the authentication and request requirements for your selected IDentity API service. Match credentials, endpoints, and product configuration to the same environment.

Expected outcome

Your backend can make an authenticated request to the selected service.

Find your service contract →
Something not working?

Request rejected? Check the environment and required fields in the service reference.

Troubleshoot IDentity →
03CUSTOMER → IDMISSION

Capture & submit

Collect the inputs your service expects.

Choose the appropriate SDK capture guide, or use existing capture inputs with the direct API. Submit the selected service’s required data and images. Preserve the identifiers returned for the submission.

Expected outcome

You have a submission response and the identifiers needed to correlate the later result.

Choose your capture approach →
Something not working?

A successful submission is not automatically an approved identity result.

Troubleshoot IDentity →
04IDMISSION → YOUR BACKEND

Receive the webhook

Bring the result back to your application.

Register your callback URL under My Account → Account Settings for the correct environment. Set POST_Data_API_Required to Y in the original API request.

Abbreviated, synthetic result · JSON
{
  "Form_Status": "Approved",
  "Form_Id": "example-form-id",
  "Form_Data": {
    "Form_State_Code": "00"
  }
}

Inspect a webhook payload in your browser →

Expected outcome

Your receiver gets the result for the same Form_Id returned by the original API response.

Open the webhook reference →
Something not working?

No delivery? Check the callback URL, environment, and original request flag.

Troubleshoot IDentity →
05YOUR BACKEND → IDMISSION

Acknowledge receipt

Respond using the IDentity contract.

The legacy reference specifies HTTP 200 and shows the acknowledgement below. Implement your application’s handling around this contract; confirm delivery and security requirements with your IDmission team.

Acknowledgement · HTTP 200
{
  "status_code": 0,
  "status_message": "Success"
}
Expected outcome

Your receiver returns HTTP 200 with the documented acknowledgement body.

Read acknowledgement requirements →
Something not working?

The legacy reference does not specify retry timing or signature verification. Do not assume ONBO’s rules apply.

Troubleshoot IDentity →
06YOUR APPLICATION

Interpret the result

Turn a form state into the right next step.

Read Form_Status together with Form_Data.Form_State_Code. Keep codes as strings. Distinguish processing, manual review, and result states before your application decides what happens next.

PROCESSINGSubmitted · 01

Processing is still underway.

MANUAL REVIEWReview states

Consult Appendix D.

RESULTApproved · 00

Interpret using Appendix C.

A code alone may not uniquely identify a state. Use its name and lifecycle context, and follow the reference’s recommended action.

Open the review-state reference →

Find this state in the result explorer →

Expected outcome

Your application handles pending work, manual review, and completed outcomes separately.

Explore final & processing states →
Something not working?

Pending Review is not a final decision. Consult the separate review-state reference.

Troubleshoot IDentity →

Your next step

Check your integration against the complete service contract and test its processing, review, and final-result paths in your sandbox.

Browse the complete IDentity reference →

Based on the imported IDentity API, webhook, and Appendix references linked above. This guide’s expected outcomes describe what to check; they do not verify your integration. How source updates work →

Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.