Purpose: Upload barcode data captured by scanner hardware for use in an API-only transaction.

Auth: Requires a client_token bearer token for authentication in the Authorization header parameter. Authorization: Bearer <token>

Note: Because the client_token is safe to pass client-side, this endpoint may be called from a browser or mobile app.

Expected Response: Feedback on the uploaded scan including issue_details, issues and, next_step. Expand sample 200 response or review the API-only documentation for details.

Additional Requirements:

  • The id_scans array requires a base64-encoded extracted_data string to represent the data being scanned from the particular scan_type.
  • The only scan_type permitted at this time is pdf417.

Add an object and populate values in the Body Params panel below to test


U.S. Restrictions

Due to legal restrictions Berbix does not accept images of United States military ID cards or Social Security cards.

Callers should make sure to handle cases where unsupported_id_type is in the list of issues returned, which indicates Berbix detected an ID type that we cannot accept.

Click Try It! to start a request and see the response here!