miiCard Claims API

The miiCard Claims API provides a simple interface for obtaining the set of identity details that a miiCard member has elected to share with your web application.

Access to the API requires the use of OAuth-authorised requests, and that the miiCard member has authorised your application to consume the relevant identity details. The Authorisation Workflow page details the end-user experience.

You'll need:

Endpoints

EndpointURL, notes
?SOAPhttps://sts.miicard.com/api/v1/Claims.svc?
?XML (POX)https://sts.miicard.com/api/v1/Claims.svc/xml? HTTP POST only
Example: https://sts.miicard.com/api/v1/Claims.svc/xml/GetClaims
?JSON? https://sts.miicard.com/api/v1/Claims.svc/json HTTP POST only
Example: https://sts.miicard.com/api/v1/Claims.svc/json/GetClaims
Important

Ensure that the Content-type header of the request is appropriate to the endpoint being consumed - for example, when consuming the JSON endpoint your request's Content-Type should be 'application/json'.

The XML endpoint expects a wrapped request if any parameters are to be sent - see the Sample API Output page for more details.

Note

The miiCard member whose details are returned by the Claims API is determined from the OAuth authorisation information supplied in the request. For the purposes of the rest of the documentation, 'current user', 'miiCard user' and 'miiCard member' should be considered to mean 'the user on whose behalf the OAuth request to the API was made'.

Methods

GetClaims method

Returns a subset of a miiCard member's identity information as agreed by them.?

Parametersnone
?Return typeMiiApiResponse of MiiUserProfile (described below)

The member whose information is to be returned is determined from the authorisation information supplied by the relying party in an HTTP Authorization header — this will depend on the authorisation protocol you're using. On success, a structure is returned to the caller containing a subset of their identity information. The subset shall contain at minimum:

  • Their full name (e.g. 'John Doe')
  • A flag indicating whether they have a public profile page
  • A URL linking to their public profile page - this is supplied irrespective of the above flag
  • A URL linking directly to the member's miiCard-image as can be seen on the profile page for easy embedding - this will be inaccessible if the member doesn't have a public profile page

In addition, further information may be populated depending upon the set of claims that the relying party requested be sent, and the set of claims that the member ultimately agreed to share with the relying party. You can configure the set of claims you want or absolutely require from a miiCard member when your request your consumer key and secret or via the self-management Business Portal.

Important

The miiCard member can only elect to share identity information that has been verified by miiCard. However, once they've agreed to share that information it is possible that some or all of it may lapse into an unverified state.

For example, the level of assurance that you require may no longer be met, or the member might have changed their surname and needs now to re-validate all of their social media accounts. As such, it's possible that over time the Claims API yields unverified information. The consumer must make sure to check the Verified property on any phone-number, email address, identity or postal address, and further check the IdentityAssured property on the top-level MiiUserProfile object.

GetIdentitySnapshot method Transactional

Returns a subset of a miiCard member's identity information as agreed by them.?

ParameterssnapshotId
  • The unique ID of the snapshot to be retrieved. You can discover what snapshots are available for a miiCard member by calling the GetIdentitySnapshotDetails method with empty snapshotId.
?Return typeMiiApiResponse of an IdentitySnapshot object

When your application is configured for transactional model use, each time a miiCard member goes through the Authorisation Workflow a snapshot of their identity information is taken. You can then supply the unique identifier of that snapshot to the GetIdentitySnapshot method and obtain a point-in-time view of the subset of that member's identity data that they elected to share with your application.

This data:

  • Is available for 7 years from the point at which the snapshot was taken
  • Persists even if the miiCard member deletes their account or revokes access to their live identity data for your application
  • Is collected and is available for all miiCard members, even those without a premium subscription

GetIdentitySnapshotDetails method Transactional

Returns the metadata associated with every identity snapshot your application has obtained of a particular miiCard member?

ParameterssnapshotId (optional)
  • The unique ID of the particular snapshot whose metadata is to be retrieved. If empty, details of all snapshots against the miiCard member are returned.
?Return typeMiiApiResponse of a collection of IdentitySnapshotDetails objects

When your application is configured for transactional model use, each time a miiCard member goes through the Authorisation Workflow a snapshot of their identity information is taken. You can discover the latest snapshots of a member's identity by calling this method when the member returns to your application from the OAuth process.

GetIdentitySnapshotPdf method Transactional

Gets a PDF rendering of the information contained in an identity snapshot

ParameterssnapshotId
  • The unique ID of the particular snapshot for which a PDF should be returned.
?Return typeA stream containing the bytes of the PDF document, with content type application/pdf

While the PDF is not itself an assurance or proof of identity, it can be useful in some situations to have a document to archive. The PDF contains the snapshot ID as well as the data shared and timestamp information.

IsUserAssured method

Determines whether the miiCard member's identity has been assured to the level of assurance required by your developer profile.

?Parametersnone
?Return typeMiiApiResponse of ?boolean (described below)

IsUserAssured determines whether the current member's identity has been validated and assured by miiCard. The specific level of assurance will depend upon your use-case — by default we require that they have linked a single financial account to their profile to validate their name and identity.

It is anticipated that the caller will use this information to give some visual indication on their site that the member's identity has been verified by miiCard. For example, it might form the basis of a profile badge, or an overlay upon their profile image.

Returns

  • True if the member's identity has been assured
  • False otherwise

IsSocialAccountAssured method

Determines whether the miiCard member has verified ownership of a particular social network account.

?ParameterssocialAccountId
  • The member's username on the social network for which data is required.

socialAccountType

  • The name of the social network to which the username belongs. A list of appropriate values is available in the remarks section below.
?Return typeMiiApiResponse of ?boolean

IsSocialAccountAssured allows the caller to verify that a particular miiCard member owns an account on a social network, so long as they has elected to share those details with your application. The socialAccountId parameter is generally expected to be a username or public profile URL unless otherwise noted. The socialAccountType parameter can be one of the following:

  • Facebook
    • socialAccountId should be the URL of the public profile page of the member or their internal numerical ID as supplied by the Facebook API
  • Twitter
  • LinkedIn
  • Google (for Google+ accounts)
  • LiveID

The socialAccountType is treated case-insensitively. The set of values that can be supplied will expand as miiCard expands the number of social accounts that can be validated - check back often to find out the latest set, which will be updated above.

Returns

  • True if the miiCard member has verified that they own the social network account specified
  • False otherwise. Note, that if the member has elected not to share information about the requested social network with your application false shall also be returned.

AssuranceImage method

Gets an image representation of the identity assurance level of a miiCard member.

?Parameters
type
  • The kind of graphic to be returned. Must be one of:
    • badge
    • badge-small
    • banner
Return typeStream - a stream of bytes representing a PNG image, with content type 'image/png' if the request was made via the JSON or XML end-points. Importantly, there is no wrapping around the response of the method - expect raw image data, and not a MiiApiResponse object as with most of the other API methods

AssuranceImage allows you to quickly present a miiCard badge on a user profile or similar while simultaneously checking the miiCard member's identity assurance status. This method is intended for low-volume consumption, and isn't likely to be the best method for larger sites.

Note

The caller will have to relay the stream from the miiCard server to the client machine, as the request will not be serviced if it is not accompanied by an HTTP Authorization header and client machines will not have the requisite information to make such a request. This relaying is very straightforward in most applications, and allows you to perform caching or additional referrer checks as necessary.

Important

It is recommended that the caller cache the output of the call, or that they use the IsUserAssured method and manually render the correct assurance badge if they expect anything more than a modest amount of site traffic.

The following table shows the results of this call rendered as PNG images, for the cases where the miiCard member's identity matches your level of assurance requirements, and for the cases where it does not.

?Type parameter valueUser's identity is assured?User's identity is not assured?
?badge-small?40x18 px?40x18 px
?badge?118x53 px?118x53px
?banner?365x48px365x48px

Returns

  • An image in line with the above table if the specified 'type' was recognised
  • A null stream otherwise

GetCardImage method Transactional

Gets a card-image representation of the identity assurance level of a miiCard member.

?Parameters
configuration
Return typeStream - a stream of bytes representing a PNG image, with content type 'image/png' if the request was made via the JSON or XML end-points. Importantly, there is no wrapping around the response of the method - expect raw image data, and not a MiiApiResponse object as with most of the other API methods

GetCardImage is intended to be a more flexible and full-featured replacement for AssuranceImage (though the AssuranceImage method continues to be supported.

GetCardImage differs from AssuranceImage in that it supports the Transactional Model - if a snapshot ID is supplied in the configuration object then the data rendered in the card image shall reflect the data within the snapshot.

Two formats of card image are currently supported, 'card' which is a full-sized (as seen on the miiCard public profile pages) image, and 'signature' which is less tall and designed for forum signatures or other small spaces.

By default GetCardImage will not render the miiCard member's phone number or email address. You can configure these two rendering options individually in the CardImageConfiguration object.

Note

The caller will have to relay the stream from the miiCard server to the client machine, as the request will not be serviced if it is not accompanied by an HTTP Authorization header and client machines will not have the requisite information to make such a request. This relaying is very straightforward in most applications, and allows you to perform caching or additional referrer checks as necessary.

Important

It is recommended that the caller cache the output of the call if they expect anything more than a modest amount of site traffic.

?CardImageConfiguration 'format' parameter valueSample output?
?card (or an empty string)Full-sized card image
318x193 px
?signatureSlim card image
?319x127 px

Returns

  • An image in line with the above table if no snapshot ID is supplied and the miiCard member has not revoked access to your application, or if the supplied snapshot ID is valid
  • A null stream otherwise

GetAuthenticationDetails method

Returns summary information about how a miiCard member authenticated with the service to authorise your application, including their location at the time if available and shared.?

Parametersnone
?Return typeMiiApiResponse of AuthenticationDetails (described below)

Determining how a miiCard member authenticated with the service to authorise your application's access to their data lets you take additional measures or skip steps in your own workflow, depending on the type of authentication used.

For example, if a miiCard member performed an authentication that involved 2-step verification, you may elect to not perform any 2-step verification in your own service as a result.

In addition, a miiCard member can elect to share their geographic location at the point of authentication with you by way of the Toopher app for iOS and Android. This can allow your application to produce localised results, offer geographically-relevant content or amend access levels depending on current location.

RefreshCreditBureauData method

Requests that miiCard requests up-to-date data attributed to the member from the third party credit bureau (credit reference agency).?

Parametersnone
?Return typeMiiApiResponse of CreditBureauRefreshStatus (described below)

There is no guarantee that more up-to-date data is available from the credit bureau.

IsCreditBureauRefreshInProgress method

Checks to see if a credit bureau data refresh is currently in progress.?

Parametersnone
?Return typeMiiApiResponse of boolean

Requests to refresh credit bureau data via calls to the RefreshCreditBureauData method can take up to a couple of minutes. The application can poll the response from IsCreditBureauRefreshInProgress periodically to determine when a call to GetClaims is likely to yield new data.

There is little point calling this method more frequently than every 10 seconds or so given the relatively long wait time for completion of a data refresh.

Data type definitions

Unless otherwise noted, these definitions indicate the structure of responses - the wire format of the response will depend on the API end-point being called (for example, the structure would be rendered to JSON if a JSON endpoint were consumed).

MiiApiResponse type

A wrapper that surrounds all responses to API calls detailing the success or failure of the call and containing additional information to help diagnosing issues.

Note

Unless otherwise indicated, all API calls return an object of type MiiApiResponse which wraps the actual response type of the API call.

FieldTypeNotes
StatusMiiApiCallStatus enumA member of the MiiApiCallStatus enumeration that describes the overall status of the API call.
ErrorCodeMiiApiErrorCode enumA member of the MiiApiErrorCode enumeration that describes the nature of any error that occurred while making the API call.
ErrorMessagestringAdditional error message that may optionally be supplied for certain types of API error. This is intended for caller diagnostics only, and should not be output to the user.
DatavariantThe payload of the response. The data type will depend upon the API method being called.
IsTestUserboolean

Specifies if the user on whose behalf you made the API call is currently marked as a 'tester' for your application. Test users always report as having valid identities - you should allow them to access your application only during development.

MiiApiCallStatus enumeration type

Enumeration type that describes the overall status of an API call.

MemberNumeric codeDescription
Success0The API call succeeded - the associated result information can be found in the Data property of the response object.
Failure1The API call failed. You can get more information about the nature of the failure by examining the ErrorCode field.

MiiApiErrorCode enumeration type

Enumeration type that details a specific problem that occurred when accessing the API.

MemberNumeric codeDescription
Success0The API call succeeded.
AccessRevoked100The member has revoked access to your application. The member would have to repeat the Authorisation Workflow process before access would be restored to your application.
UserSubscriptionLapsed200The member's miiCard subscription has elapsed. Only members with a current subscription can share their data with other applications and websites.
TransactionalSupportDisabled1000Your application has not been enabled for transactional support but you are attempting to make a call to a part of the API that relates to the transactional charging model
FinancialDataSupportDisabled1001Your application has not been enabled for financial data sharing support but you are attempting to make a call to the Financial API
DevelopmentTransactionalSupportOnly1010Your application has been configured for transactional usage for nominated test accounts, and the member attempting to go through the Authorisation Workflow is not one of those test accounts.
InvalidSnapshotId1020The snapshot ID provided to a method that expects a snapshot ID does not exist, or does not belong to the member on whose behalf you are making an API
CreditBureauUpdatesUnavailable1030Indicates that credit bureau updates are unavailable at the present time.
Blacklisted2000Your application has been suspended and no API access can take place until miiCard releases the suspension on your application.
ProductDisabled2010Your application has been disabled, either by your request or by miiCard. miiCard members will be unable to go through the Authorisation Workflow for your application, though you will still be able to access the API.
ProductDeleted2020Your application has been deleted. miiCard members will be unable to go through the Authorisation Workflow process for your application, nor will you be able to access identity details through the API.
Exception10000A general exception occurred during processing - details may be available in the ErrorMessage property of the response object depending on the nature of the exception.

WebPropertyType enumeration type

Enumeration type that details the kind of web property a member has linked to their miiCard profile - used by the WebProperty object type.

MemberNumeric codeDescription
Domain0A domain name has been linked.
Website1A website or page has been linked by its URL.

MiiUserProfile type

A structured representation of the subset of a miiCard member's identity that they have agreed to share with the relying party.

Field?TypeNotes
Salutationstring'Mr', 'Mrs' etc.
FullNamestringVerified full name of the member.
FirstNamestring 
MiddleName?stringIf applicable?.
LastNamestring 
DateOfBirthoptional DateTimeThe miiCard member's verified date of birth.
PreviousFirstNamestring?If the member has legally changed their name, their first name prior to the change? - otherwise empty.
?PreviousMiddleName?string?If the member has legally changed their name, their middle name prior to the change? - otherwise empty.
PreviousLastNamestringIf the member has legally changed their name, their last name prior to the change - otherwise empty.
LastVerifiedDateTimeDate and time that the member's financial (or equivalent) validation was last performed. Systems demanding a high level of assurance in the user's identity should consider interrogating this field and implementing a staleness check.
ProfileUrlstringA URL to the member's public miiCard profile page. Note that this is a calculated value, and is always supplied even if the member doesn't have a public profile. The caller should check the HasPublicProfile field in tandem with this field.
ProfileShortUrlstringThe shortened URL of the member's miiCard profile page. Note that this is a calculated value, and is always supplied even if the member doesn't have a public profile. The caller should check the HasPublicProfile field in tandem with this field.
?CardImageUrl?string?A URL to the member's miiCard image as is shown on their profile page. This image is dynamically generated and the URL provided for easy embedding. Note that this is a calculated value, and is always supplied even if the member doesn't have a public profile. The caller should check the HasPublicProfile field in tandem with this field.
EmailAddressesCollection of EmailAddress?A collection of email addresses associated with the member.
?Identities?Collection of Identity?A collection of alternative identities for the member - for example, on social media sites.
?PhoneNumbers?Collection of PhoneNumber?A collection of phone numbers associated with the member.
?PostalAddresses?Collection of PostalAddress?A collection of postal addresses associated with the member.
Qualifications?Collection of Qualification?A collection of academic qualifications and professional memberships associated with the member.
WebPropertiesCollection of WebPropertyA collection of web properties associated with the member, such as domain names or URLs.
?IdentityAssuredboolean??Whether the information about the member meets the level of assurance you configured in your developer profile. You should always check the value of this property to ensure that you are only using validated information.
HasPublicProfilebooleanIndicates whether the member has published any of their identity information publicly on their public profile page. This isn't a mandatory step for a member, so the consumer should check the value of this field before linking to the URL supplied in the ProfileUrl field or trying to render the CardImage URL
PublicProfileMiiUserProfileIf the member has published any portion of their identity on their public profile page, and if the member has elected to share that information with your application, that same set of details shall be accessible via this field.

EmailAddress type

Represents an email address that the member has linked to their miiCard profile, and for which ownership has been verified.

FieldTypeNotes
DisplayName?stringThe name that the member has used to describe this email address. The consuming party should consider using this name when referring to the email address, as it may have specific meaning for the member. Equally the consuming party should not try to infer the kind of email address from the display name.
AddressstringThe email address.
IsPrimarybooleanIf true, the member has specified that this is their primary email address. If multiple email addresses are supplied to the consumer, they should consider preferring the one marked as 'IsPrimary'.
VerifiedbooleanIf true, the email address has been verified as linked to this miiCard member. The consumer should always check the Verified field as while the member cannot initially share information that hasn't been verified, it's possible that the information subsequently lapses into an unverified state.

Identity type

Represents the member's account details on another website, such as a social-media site.

FieldType?Notes
Sourcestring

The name of the site to which the identity pertains. This is not an enumeration-type field and may grow to include more values in the future. Current possible values include:

  • Facebook
  • Google
  • LinkedIn
  • LiveID
  • Twitter
  • eBay

Consumers should not rely on the casing of the returned value, and perform all comparisons case-insensitively.

UserIdstringThe member's username or user ID on the site.
?ProfileUrlstringIf one exists and is available, the URL to the member's public profile page on the site.
Verifiedboolean?If true, the social media identity has been verified as linked to this miiCard member. The consumer should always check the Verified field as while the member cannot initially share information that hasn't been verified, it's possible that the information subsequently lapses into an unverified state.

PhoneNumber type

Represents a phone number that the member has linked to their miiCard profile, and for which ownership has been verified.
Field?TypeNotes
DisplayNamestringThe name that the member has used to describe this phone number. The consuming party should consider using this name when referring to the phone number, as it may have specific meaning for the member. Equally the consuming party should not try to infer the kind of phone number from the display name.
CountryCodestringThe ITU-T E.164 country code of the phone number.
NationalNumberstringThe national component of the phone number.
IsMobilebooleanTrue if the phone number is linked to a mobile telephone.
IsPrimarybooleanIf true, the member has specified that this is their primary phone number. If multiple phone numbers are supplied to the consumer, they should consider preferring the one marked as 'IsPrimary'.
Verifiedboolean?If true, the phone number has been verified as linked to this miiCard member. The consumer should always check the Verified field as while the member cannot initially share information that hasn't been verified, it's possible that the information subsequently lapses into an unverified state.

PostalAddress type

Represents a postal address that the member has linked to their miiCard profile, and at which the member has demonstrated they are resident.

Field?Type?Notes
HousestringThe name or number of the building referred to by the address.
Line1stringThe first line of the address.
?Line2stringThe second line of the address.
CitystringThe city of the address.
RegionstringThe region (for example county, state or department) of the address.
CodestringThe postal code of the address.
CountrystringThe country of the address.
IsPrimarybooleanIf true, the member has specified that this is their primary address (i.e. the address to which correspondence would ordinarily be sent). If multiple addresses are supplied to the consumer, they should consider preferring the one marked as 'IsPrimary'.
Verifiedboolean?If? true, the postal address has been verified as linked to this miiCard member. The consumer should always check the Verified field as while the member cannot initially share information that hasn't been verified, it's possible that the information subsequently lapses into an unverified state.

Qualification type

Represents an academic or professional qualification attained by this miiCard member.

Field?Type?Notes
TypeQualificationTypeA QualificationType enumeration member describing the kind of qualification attained.
TitlestringThe title of the qualification. For academic qualifications this may be the level of qualification attained (like 'PhD' or 'MA') or include a full course title, depending on the data provider.
DataProviderstringThe name of the data provider.
DataProviderUrlstringThe URL to the miiCard member's page at the data provider that illustrates the attained qualification, or to the data provider's site if such a page doesn't exist

QualificationType enumeration type

Enumeration type that details the kind of qualification a miiCard member has attained - used by the Qualification object type.

MemberNumeric codeDescription
Academic0An academic qualification such as a degree, diploma or certificate
Professional1Membership of a professional body or a professional qualification/certificate.

WebProperty type

Represents a web property that the member has linked to their miiCard profile, for example a domain name or a web page.

Field?Type?Notes
DisplayNamestringThe display name that the member has given the web property. When referring to the property in your own applications, it is recommended that you use or at least include this display name as it may have specific meaning to the user.
IdentifierstringThe identifier of the web property, which will be specific to the type of property being described. For domain-type properties this will be the domain name, while for site-type properties this will be a URL to the page or site.
TypeWebPropertyType enumThe type of web property that has been linked.
?Verifiedboolean?If? true, the web property has been verified as linked to this miiCard member. The consumer should always check the Verified field as while the member cannot initially share information that hasn't been verified, it's possible that the information subsequently lapses into an unverified state.

IdentitySnapshotDetails type

Represents the metadata associated with a single point-in-time snapshot of a miiCard member's identity data.

Field?Type?Notes
SnapshotIdstringThe unique identifier for the snapshot - you can record this for auditing purposes.
UsernamestringThe username of the miiCard member whose identity data is contained within the snapshot.
TimestampUtcDateTimeThe date and time (in UTC) at which the snapshot was created - you can record this for auditing purposes. You should examine this field before pushing a miiCard member through the Authorisation Workflow to avoid unexpected charges on your account.
WasTestUserboolean?If? true, indicates that the miiCard member was marked as a 'tester' for your application at the point at which the snapshot of their identity was taken - as such, the stored identity verification details cannot be trusted. Your production code should disregard snapshots of this type.

IdentitySnapshot type

Represents a single point-in-time snapshot of a miiCard member's identity data.

Field?Type?Notes
DetailsIdentitySnapshotDetailsAn IdentitySnapshotDetails object containing a description of the snapshotted data.
SnapshotMiiUserProfileA MiiUserProfile object that contains the subset of the miiCard member's identity data that they agreed to share at the point in time the snapshot was taken.

CardImageConfiguration type

Describes the format and information that should be included in a card image as returned by GetCardImage

Field?Type?Notes
FormatstringThe (optional) format in which the card image should be rendered. If not supplied, 'card' is assumed. Must be one of:
  • card - a full-sized card image
  • signature - a slimmer form (with no room for email or phone number) useful in forum signatures or tight spaces
SnapshotIdstringThe ID of the snapshot from which data should be pulled to generate the card image, if supplied. If not supplied then live data is used instead.
ShowPhoneNumberbooleanIf true, the miiCard member's phone number is rendered into the card image (if they have shared that information with your application). Not applicable for 'signature' style images
ShowEmailAddressbooleanIf true, the miiCard member's email address is rendered into the card image (if they have shared that information with your application). Not applicable for 'signature' style images

AuthenticationDetails type

Describes the circumstances under which the miiCard member last authenticated for your application.

Field?Type?Notes
AuthenticationTimeUtcDateTime or nullThe date and time at which authentication took place
SecondFactorTokenTypeAn AuthenticationTokenType enumeration memberThe AuthenticationTokenType that represents the manner of 2-step verification that took place, if any.
SecondFactorProviderstringThe kind of second factor that was employed during 2-step verification, if it was used. Currently can be one of:
  • SMS - a text message sent to a mobile device with a one-time code
  • Toopher - a two-factor authentication app for iOS and Android
  • YubiKey - a hardware token generator
LocationsCollection of GeographicLocation objectsZero or more reported geographic locations for the miiCard member, if they elected to share their current location with your application and your application is configured for a geolocation claim

GeographicLocation type

A miiCard member's geographic location as reported by a single data provider.

Field?Type?Notes
LocationProviderstringThe name of the location provider. Currently only 'Toopher'.
LatitudeDecimal, or nullThe latitude of the member's location at authentication-time, or null if not available or not shared. Supplied only if your API key is configured for the Location (detailed) claim.
LongitudeDecimal, or nullThe longitude of the member's location at authentication-time, or null if not available or not shared. Supplied only if your API key is configured for the Location (detailed) claim.
LatLongAccuracyMetresIntegerThe approximate accuracy of the reported latitude and longitude figures or null if not available or not shared. Supplied only if your API key is configured for the Location (detailed) claim.
ApproximateAddressPostalAddressThe approximate postal address of the location as reported by the provider, if known. Not all fields of the PostalAddress object may be populated depending on data availability. If you have specified only the Location (city) claim, only the country, city and region fields will be populated.

AuthenticationTokenType enumeration type

Enumeration type that details the kind of second-factor used during a 2-step verification process during authentication.

MemberNumeric codeDescription
None0No 2-step verification was employed.
Soft1A software token, such as a token generator app or an SMS sent to a mobile device was used.
Hard2A hardware token, such as a YubiKey was used.

CreditBureauVerification type

A structured representation of data about a miiCard member that has been received from a third-party credit bureau (credit reference agency).

FieldTypeNotes
DatastringJSON data structure. This data is passed on as is from the third party without modification, miiCard takes no responsibility for its accuracy or validity.
LastVerifiedDateTimeThe date and time that the corresponding Data field was last refreshed.

CreditBureauRefreshStatus type

Represents the status of a request to refresh credit bureau data for a miiCard member.

FieldTypeNotes
RefreshStateRefreshState enumeration memberThe state of the refresh request.