The InstantCard JSON/REST API . All API responses are JSON (including errors), but are easily converted to objects in any language. We use standard HTTP status/response codes.
To facilitate testing, all examples use a dummy account in a staging environment https://staging.core.instantcard.net/api/v2/. To implement our APIs in a production environment, you must use the base path
In lieu of a standard API key, we use a login/authentication POST method to retrieve a login token. This token is then used for all subsequent calls. Since this token has an expiry, authentication is required for each session.
Note on contacts and addresses:
While separated into different sections, with their own endpoints, contacts and addresses were designed to work in tandem. To this end, individual contacts may be linked to individual addresses and vise-versa. If you wish to treat these as a single entity, you may define all fields through the ADDRESSES endpoints (which accepts all parameters that define a contact).
It is possible that you wish to see an example call implemented in a language which we haven’t shown. In this case, please feel free to contact us and we’ll add it as soon as possible.
To test the API for yourself without an account, feel free to use the following credentials:
The InstantCard API was designed with certain workflows in mind. For example, in creating a card we developed a system designed to create a draft, preview that draft, and update if needed before any sort of finalization. So, to this end feel free to consult some of the following recommended workflows. You will notice that many of our endpoints do not make it into these examples, as they aren’t required by the typical client.
If there is any workflow you would like to see, but isn’t listed here, please feel free to Contact Us.