Mule Account Database

Common objects & errors

Both Mule Account Database endpoints take the same request body — an image and an account_identifier — and they fail the same way at the transport layer. All of it is defined once, here, and referred to by name from each endpoint page.

Request objects

Clients can provide image data to the TrustVision API by specifying the ID the image by using upload API, or by sending the image data as base64-encoded text.

image

Image of the identity card's front side. Report an account and Search for an account each take one, in image.

• If you use id, omit base64, label, metadata, and embedding.
• If you use base64, you can also include label and metadata. Omit id and embedding.
• If you use embedding, omit all other image parameters.
• The priority order for processing is: id, then base64, then embedding.

account_identifier

Contains info about the account holder's identity. Both endpoints take one, in account_identifier.

Report an account also documents a flag field on this object. Search for an account does not.

Errors

Every response carries an errors array alongside data. Each entry has a code, a message and a detail object, in which field is optional and says which parameter is invalid, alongside any other information that can be useful for client. The shape is written out in the response block on each endpoint page.

The codes that arrive with HTTP 200 and data.status: "failure" are listed under Failure codes on the endpoint that returned them.

Shared transport errors

In case of any other errors, the data field will be empty, and the server sends one of the following HTTP status codes with an error code. These are the same on both calls.