BankID on mobile

API Reference

bank-id

GET /bank-id/v1/msisdn/{msisdn} Get the status of bank id for a given msisdn
Description Error responses Try it

Implementation notes

Parameters

  • Authorization*
  • The authorization header containing the access token. See the oauth-v2 API for how to obtain the token. Example: "Authorization: Bearer 065d160140eea13e72cde31a7b857bbfa37390e5"
  • header
  • string
  • msisdn*
  • The msisdn of to get bank id status for
  • path
  • string

Response class (Status 200)

Model | Model schema

canOrderboolean
True if this subscription can order Bank id, false of not
subscriptionInfoSubscriptionInfo
If canOrder is true, this is set and provides information about the subscription that qualifies for Bank id
declinedInfoDeclinedInfo
If canOrder is false, this is set and provides information about the why the subscription does not qualify for Bank id

SubscriptionInfo

iccIdstring
The icc id for the sim card used by the subscription
provider
Information about the provider of the subscription

DeclinedInfo

reasonstring
The reason that the msisdn does not qualify for Bank id. These values can be coded as against as enums. For a more verbose reason, see _detailedReason_ ### Possible values 1. **SUBSCRIPTION_NOT_FOUND** No subscription found for the given msisdn 1. **SUBSCRIPTION_IS_BARRED** The subscription is barred 1. **NOT_MAIN_SIMCARD** The msisdn is for a addon sim service, not the main subscription 1. **SUBSCRIPTION_DOES_NOT_QUALIFY_FOR_BANKID** The subscription does not qualify for the bank id product 1. **SUBSCRIPTION_UNDER_PORTING** The subscription will port to another provider in near future and cannot be changed 1. **SUBSCRIPTION_HAS_BLOCKING_ORDER** A current order registered on the subscription is currently blocking any changes 1. **NO_ICC_ID_FOUND** Could not find the ICC id associated with this subscription
detailedReasonstring
A text that will help explaining why _canOrder_ is false. Adds more detail to the field _reason_. Log this to have history about why Bank id was declined for the msisdn
{
  "canOrder": "N/A",
  "subscriptionInfo": {
    "iccId": "string",
    "provider": {
      "id": 1,
      "name": "Telenor"
    }
  },
  "declinedInfo": {
    "reason": "string",
    "detailedReason": "string"
  }
}

Error responses

400
Bad Request:
Error code 400001 - Invalid MSISDN
Error code 40001 - Missing or invalid enduserId
401
Unauthorized:
Error code 40101 - Invalid resource
Error code 40102 - Missing authorization header
Error code 40103 - No API product found
Error code 40104 - Not authorized to use given MSISDN
Error code 40105 - Invalid access token
Error code 40106 - Access token expired
Error code 40107 - Basic authentication not allowed for external access or not allowed for client
Error code 40108 - Invalid client id or secret for basic authentication
403
Forbidden:
Error code 40301 - Invalid scope
404
Not Found:
Error code 40401 - Path or method not found
Error code 4042000 - Path or method not found on back-end server
429
Too Many Requests:
Error code 42901 - Rate limit quota violation
Error code 42902 - Spike arrest violation
500
Internal Server Error:
Error code 50001 - Internal Server Error
Error code 50002 - Failed to validate acr
Error code 50003 - Failed to validate subscription
Error code 500100 - Internal server error
503
Service Unavailable:
Error code 503200 - External server error
The Try-It functionality is only available when logged in to the portal.
POST /bank-id/v1/msisdn/{msisdn}/bankid Add the bank id product to this subscription
Description Error responses Try it

Implementation notes

Parameters

  • Authorization*
  • The authorization header containing the access token. See the oauth-v2 API for how to obtain the token. Example: "Authorization: Bearer 065d160140eea13e72cde31a7b857bbfa37390e5"
  • header
  • string
  • msisdn*
  • The msisdn of to add the bank id product to
  • path
  • string

Response class (Status 200)

Model | Model schema

createdboolean
True if an order was created, false if nothing needed to be changed
orderIdstring
The id of this order. Set if 'created' is true
{
  "created": "N/A",
  "orderId": "string"
}

Error responses

400
Bad Request:
Error code 400001 - Invalid MSISDN
Error code 40001 - Missing or invalid enduserId
401
Unauthorized:
Error code 40101 - Invalid resource
Error code 40102 - Missing authorization header
Error code 40103 - No API product found
Error code 40104 - Not authorized to use given MSISDN
Error code 40105 - Invalid access token
Error code 40106 - Access token expired
Error code 40107 - Basic authentication not allowed for external access or not allowed for client
Error code 40108 - Invalid client id or secret for basic authentication
403
Forbidden:
Error code 403001 - Bank id not available for this msisdn
Error code 40301 - Invalid scope
404
Not Found:
Error code 40401 - Path or method not found
Error code 4042000 - Path or method not found on back-end server
429
Too Many Requests:
Error code 42901 - Rate limit quota violation
Error code 42902 - Spike arrest violation
500
Internal Server Error:
Error code 50001 - Internal Server Error
Error code 50002 - Failed to validate acr
Error code 50003 - Failed to validate subscription
Error code 500100 - Internal server error
503
Service Unavailable:
Error code 503200 - External server error
The Try-It functionality is only available when logged in to the portal.
DELETE /bank-id/v1/msisdn/{msisdn}/bankid Remove the bank id product from this subscription
Description Error responses Try it

Implementation notes

Parameters

  • Authorization*
  • The authorization header containing the access token. See the oauth-v2 API for how to obtain the token. Example: "Authorization: Bearer 065d160140eea13e72cde31a7b857bbfa37390e5"
  • header
  • string
  • msisdn*
  • The msisdn of to remove the bank id product to
  • path
  • string

Response class (Status 200)

Model | Model schema

createdboolean
True if an order was created, false if nothing needed to be changed
orderIdstring
The id of this order. Set if 'created' is true
{
  "created": "N/A",
  "orderId": "string"
}

Error responses

400
Bad Request:
Error code 400001 - Invalid MSISDN
Error code 40001 - Missing or invalid enduserId
401
Unauthorized:
Error code 40101 - Invalid resource
Error code 40102 - Missing authorization header
Error code 40103 - No API product found
Error code 40104 - Not authorized to use given MSISDN
Error code 40105 - Invalid access token
Error code 40106 - Access token expired
Error code 40107 - Basic authentication not allowed for external access or not allowed for client
Error code 40108 - Invalid client id or secret for basic authentication
403
Forbidden:
Error code 40301 - Invalid scope
404
Not Found:
Error code 40401 - Path or method not found
Error code 4042000 - Path or method not found on back-end server
429
Too Many Requests:
Error code 42901 - Rate limit quota violation
Error code 42902 - Spike arrest violation
500
Internal Server Error:
Error code 50001 - Internal Server Error
Error code 50002 - Failed to validate acr
Error code 50003 - Failed to validate subscription
Error code 500100 - Internal server error
503
Service Unavailable:
Error code 503200 - External server error
The Try-It functionality is only available when logged in to the portal.