To access the APIs you'll need miiCard to configure an OAuth 1.0a consumer key and consumer secret. If we have enabled your account for self-management you can do this yourself, otherwise you'll need to contact us using the form below.
We'll need to know:
- The name of your website (or company), and the URL of the website where you intend to use miiCard
- The set of details that you want to know about a miiCard user, and which (if any) of those details are mandatory for your application
- What you want to do with those user details
- For example, are you just letting users sign-in with a miiCard? Supporting a rich sign-up process? Some other use-case?
The more information you give us about what you're planning on doing the quicker we'll be able to help you out.
Once we take a look at your request we'll set up a consumer key and secret for you and you can start to use the APIs either manually, or using one of our drop-in components or wrapper libraries.
If you've got a use-case that you don't think you can fulfil using our existing API then let us know either via the support form or over on our developer forum - we're open to any and all ideas that'll make it easier for you and others to consume miiCard in your applications!
What information can I request from a miiCard member?
At present you can request any information that a miiCard member can also publish to their public profile page - we call these 'public claims'. The member doesn't have to have published their public profile for you to request data from them - it might be that they want to keep their profile private but elect to share certain information with certain sites. These are:
- Their name (which is always supplied)
- An email address - if they have multiple, they'll be asked to select a single email address
- A phone number - if they have multiple, they'll be asked to select a single phone number
- Social media and other internet identities
- Microsoft LiveID
We also provide a boolean flag indicating whether the miiCard member's identity has been assured, which shows that they have associated a financial account with their miiCard account to verify their name and identity. We call this the member's 'level of assurance'.
In the near future, miiCard will support sharing a more detailed level of assurance that you can customise to your specific application requirements. Please contact us on the support form to discuss.
Subscription vs transactional charging model
miiCard offer two ways to consume the identity details of our members; the subscriptional model and the transactional model:
- Only miiCard members with a premium subscription can share their identity with your application under the subscriptional model, but you aren't charged
- Any miiCard member can share their identity through the transactional model, but you'll be charged the first time each member does so
For more information on the differences and which use-cases each model enables, see the Types of Access page.
The easiest way to consume miiCard identity details is to use one of our wrapper libraries or drop-in components. If you don't see a library targetting your desired programming language, or a component for your preferred development framework then drop us a line and we'll get back to you.
You can also consume our API manually, using the SOAP, XML or JSON endpoints - our Claims API documentation details how to make an API call and what sort of responses to expect.
You can also see some demonstrations of miiCard in use for inspiration.