Simplified.ID API: v2

GetAccountStatus

Account

The following routes are available for this service:
GET	/account/status	Get account status

"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string,userId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User) */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key) */
    apiUserKey;
    /**
     * @type {string}
     * @description The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id). */
    userId;
}
export class BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description The authentication credentials */
    authentication;
}
export class ResponseError {
    /** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    fieldName;
    /** @type {string} */
    message;
    /** @type {{ [index:string]: string; }} */
    meta;
}
export class ArrayOfResponseError extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
    /** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    message;
    /** @type {string} */
    stackTrace;
    /** @type {ArrayOfResponseError} */
    errors;
    /** @type {{ [index:string]: string; }} */
    meta;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description The status of the response */
    responseStatus;
}
export class AccountStatus {
    /** @param {{status?:string,type?:string,expiryDate?:string,expiryDateUniversal?:string,balance?:number,creditBalance?:number,dbsBasicCreditBalance?:number,products?:string[],capabilities?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The account status (e.g. Unpaid, Active, Expired) */
    status;
    /**
     * @type {string}
     * @description The account type (e.g. live, developer, demo) */
    type;
    /**
     * @type {?string}
     * @description The account Expiry Date */
    expiryDate;
    /**
     * @type {string}
     * @description The account Expiry Date as a string in ISO 8601 format */
    expiryDateUniversal;
    /**
     * @type {number}
     * @description The account balance */
    balance;
    /**
     * @type {number}
     * @description The account search credit balance */
    creditBalance;
    /**
     * @type {number}
     * @description The account DBS credit balance */
    dbsBasicCreditBalance;
    /**
     * @type {string[]}
     * @description The list of enabled products for this account */
    products;
    /**
     * @type {string[]}
     * @description The list of enabled capabilities for this account */
    capabilities;
}
export class GetAccountStatusData extends BaseResponse {
    /** @param {{accountStatus?:AccountStatus,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {AccountStatus}
     * @description The account status information */
    accountStatus;
}
export class GetAccountStatusResponse {
    /** @param {{data?:GetAccountStatusData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {GetAccountStatusData}
     * @description The response data */
    data;
}
export class GetAccountStatus extends BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript GetAccountStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /account/status HTTP/1.1 
Host: api.simplified.id 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"accountStatus":{"status":"String","type":"String","expiryDate":"\/Date(-62135596800000-0000)\/","expiryDateUniversal":"String","balance":0,"creditBalance":0,"dbsBasicCreditBalance":0,"products":["String"],"capabilities":["String"]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}