Telkomsel Subscriber Check API

openapi: 3.0.3
info:
  title: Telkomsel DigiHub APIs Consent Management Subscriber Check API
  description: Consolidated OpenAPI for the API products Telkomsel exposes to developers and enterprises through DigiHub (https://digihub.telkomsel.com), Telkomsel's API marketplace. Paths, methods, parameters, schemas, and examples are taken verbatim from DigiHub's own published per-endpoint OpenAPI documents (served publicly at https://digihub.telkomsel.com/apis/V2/endpoint/{id}); $refs were inlined and the per-endpoint documents merged into one file. Most APIs authenticate with an api_key header plus an x-signature header of SHA256(API Key + Secret Key + epoch timestamp); the CAMARA-style SIM Swap API uses OIDC CIBA (/bc-authorize + /token) with a bearer token. Calling any of these endpoints requires a DigiHub account and a subscribed plan (sandbox, quota, tier, or PAYU); enterprise plans require an NDA or commercial contract.
  version: '2026-07-11'
  contact:
    url: https://digihub.telkomsel.com/showcase/contactus
servers:
- url: https://api.digitalcore.telkomsel.com
  description: Telkomsel Digital Core API gateway (primary DigiHub production host; some APIs are served from https://digihub.telkomsel.com instead - see path-level servers)
security:
- ApiKeyAuth: []
  SignatureAuth: []
tags:
- name: Subscriber Check
  description: MSISDN state - active status, subscriber type, roaming, call forwarding, recycled numbers.
paths:
  /digihub/subscheck/activestatus:
    post:
      summary: API Active Status
      operationId: activeStatus
      description: This API will provide insight regarding active status of particular customer.
      parameters:
      - in: header
        name: api_key
        example: '[api_key]'
        description: API Key / Package Key from Digihub
        required: true
        schema:
          type: string
      - in: header
        name: x-signature
        example: '[x-signature]'
        description: SHA256 (API Key + Secret Key + timeStamp). [More info](https://digihub.telkomsel.com/documentation/consumer-guide/api-key-api-secret)
        required: true
        schema:
          type: string
      - in: header
        name: Content-Type
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - transaction
              properties:
                transaction:
                  type: object
                  required:
                  - trx_id
                  - command
                  properties:
                    trx_id:
                      description: Unique alphanumeric character generated by partner, max 20 char
                      type: string
                      example: 040520181127010000
                    command:
                      description: Service Type
                      type: string
                      example: isSubscriberStatus
                consent:
                  type: object
                  required:
                  - msisdn
                  - consent_id
                  - code
                  properties:
                    msisdn:
                      description: MSISDN starts with “62”. Minimum length is 11 and Maximum length is 13
                      type: string
                      example: '62811917671'
                    consent_id:
                      description: Received in API Login (Consent Management).
                      type: string
                      example: O3K6lE674dF4sVE/SqcYS1zT2ENoDxU/VB6bNWPmpGbLgjqkgIdJkNg=
                    code:
                      description: Given by Telkomsel.
                      type: string
                      example: 3erthdxb299n4dg2ue74xv4s
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: Status Code
                    type: string
                    example: '00'
                  message:
                    description: Status Description
                    type: string
                    example: Success
                  trx_id:
                    description: Unique alphanumeric character generated by partner, max 20 char
                    type: string
                    example: 040520181127010000
                  result:
                    description: Potential output for this service is binary in string (yes/no)
                    type: string
                    example: Active
        '400':
          description: Invalid MSISDN / Customer not active / Parameter Param is invalid format
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction
                properties:
                  transaction_id:
                    description: Transaction ID
                    type: string
                    example: C002190726165745657448250
                  status_code:
                    description: Status Code
                    type: string
                    example: '20012'
                  status_desc:
                    description: Status Description
                    type: string
                    example: table_code is not exist
              examples:
                Invalid MSISDN:
                  value:
                    status: '20'
                    message: Invalid MSISDN
                    trx_id: 040520181127010000
                    result: ''
                Customer not active:
                  value:
                    status: '17'
                    message: Customer not active
                    trx_id: 040520181127010000
                    result: ''
                Parameter Param is invalid format:
                  value:
                    status: '21'
                    message: Parameter Param is invalid format
                    trx_id: 040520181127010000
                    result: ''
      tags:
      - Subscriber Check
      externalDocs:
        description: 'DigiHub endpoint reference: API Active Status'
        url: https://digihub.telkomsel.com/apis/V2/endpoint/127
  /digihub/subscheck/v2/activestatus:
    post:
      summary: API Active Status
      operationId: activeStatus-137
      description: This API will provide insight regarding active status of particular customer.
      parameters:
      - in: header
        name: api_key
        example: '[api_key]'
        description: API Key / Package Key from Digihub
        required: true
        schema:
          type: string
      - in: header
        name: x-signature
        example: '[x-signature]'
        description: SHA256 (API Key + Secret Key + timeStamp). [More info](https://digihub.telkomsel.com/documentation/consumer-guide/api-key-api-secret)
        required: true
        schema:
          type: string
      - in: header
        name: Content-Type
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - transaction
              properties:
                transaction:
                  type: object
                  required:
                  - transaction_id
                  - key
                  properties:
                    transaction_id:
                      description: Unique alphanumeric character generated by partner, max 20 char
                      type: string
                      example: TEST001
                    key:
                      description: Service Type
                      type: string
                      example: msisdn
                consent:
                  type: object
                  required:
                  - partner_id
                  - consent_id
                  properties:
                    partner_id:
                      description: Given by Telkomsel.
                      type: string
                      example: TfbQQR5oaTqWb0dp5qdrI7XnLBwHdfskahBbc17ghPyO7WalKR/nIw+EPblJPHd/iNsUC9Nwmfis=
                    consent_id:
                      description: Received in API Login (Consent Management).
                      type: string
                      example: XvbWQR5oaTqWb0dp5qdrI7XnLBx5/tJi+D8+o95gdzWeN8liKI3FqYx7XCosC7HnLMZTrdskKCucN9ec7up/Z2mK2e+5mhd/VcY984Jp8jsafbaRBy7XRFT+ueou4UZjg3E3Q=
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction
                properties:
                  transaction:
                    type: object
                    required:
                    - transaction_id
                    - status_code
                    - status_desc
                    properties:
                      transaction_id:
                        description: Transaction ID.
                        type: string
                        example: TEST001
                      status_code:
                        description: Status Code.
                        type: string
                        example: '00000'
                      status_desc:
                        description: Status Description.
                        type: string
                        example: Success
                  request:
                    type: object
                    required:
                    - result
                    properties:
                      result:
                        description: result
                        type: string
                        example: ACTIVE
        '400':
          description: Invalid MSISDN / Customer not active / Parameter Param is invalid format
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction
                properties:
                  transaction_id:
                    description: Transaction ID
                    type: string
                    example: C002190726165745657448250
                  status_code:
                    description: Status Code
                    type: string
                    example: '20012'
                  status_desc:
                    description: Status Description
                    type: string
                    example: table_code is not exist
              examples:
                Invalid MSISDN:
                  value:
                    status: '20'
                    message: Invalid MSISDN
                    trx_id: 040520181127010000
                    result: ''
                Customer not active:
                  value:
                    status: '17'
                    message: Customer not active
                    trx_id: 040520181127010000
                    result: ''
                Parameter Param is invalid format:
                  value:
                    status: '21'
                    message: Parameter Param is invalid format
                    trx_id: 040520181127010000
                    result: ''
      tags:
      - Subscriber Check
      externalDocs:
        description: 'DigiHub endpoint reference: API Active Status v2'
        url: https://digihub.telkomsel.com/apis/V2/endpoint/137
  /digihub/subscheck/subscribertype:
    servers:
    - url: https://digihub.telkomsel.com
    post:
      summary: This API will provide insight regarding subscriber’s subscription type of targeted customer
      operationId: subscriberType
      parameters:
      - in: header
        name: api_key
        example: e688u2hgpkzjd244wecywwv8
        description: API Key / Package Key from Digihub
        required: true
        schema:
          type: string
      - in: header
        name: x-signature
        example: ff080f3200a5945deeb59ad65e2b33788f5df49066a82afcf8b6d5bf43ff76ea
        description: SHA256 (API Key + Secret Key + timeStamp). [More info](https://digihub.telkomsel.com/documentation/consumer-guide/api-authentication)
        required: true
        schema:
          type: string
      - in: header
        name: Content-Type
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - transaction
              - consent
              properties:
                transaction:
                  type: object
                  required:
                  - trx_id
                  - command
                  - param
                  properties:
                    trx_id:
                      type: string
                      example: 040520181127010000
                    command:
                      type: string
                      example: isSubscriberType
                    param:
                      type: string
                      example: Prepaid
                consent:
                  type: object
                  required:
                  - msisdn
                  - consent_id;
                  - code
                  properties:
                    msisdn:
                      type: string
                      example: '62811917671'
                    consent_id:
                      type: string
                      example: O3K6lE674dF4sVE/SqcYS1zT2ENoDxU/VB6bNWPmpGbLgjqkgIdJkNg=
                    code:
                      type: string
                      example: 3erthdxb299n4dg2ue74xv4s
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: status
                    type: string
                    example: '00'
                  message:
                    description: message
                    type: string
                    example: Success
                  trx_id:
                    description: trx_id
                    type: string
                    example: 040520181127010000
                  result:
                    description: result
                    type: string
                    example: 'YES'
        '400':
          description: Invalid MSISDN / Customer not active / Parameter Param is invalid format
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: status
                    type: string
                    example: '20'
                  message:
                    description: message
                    type: string
                    example: Invalid MSISDN
                  trx_id:
                    description: trx_id
                    type: string
                    example: 040520181127010000
                  result:
                    description: result
                    type: string
                    example: ''
              examples:
                Invalid MSISDN:
                  value:
                    status: '20'
                    message: Invalid MSISDN
                    trx_id: 040520181127010000
                    result: ''
                Customer not active:
                  value:
                    status: '17'
                    message: Customer not active
                    trx_id: 040520181127010000
                    result: ''
                Parameter Param is invalid format:
                  value:
                    status: '21'
                    message: Parameter Param is invalid format
                    trx_id: 040520181127010000
                    result: ''
      tags:
      - Subscriber Check
      externalDocs:
        description: 'DigiHub endpoint reference: API Subscriber Type'
        url: https://digihub.telkomsel.com/apis/V2/endpoint/134
  /digihub/subscheck/roamingstatus:
    servers:
    - url: https://digihub.telkomsel.com
    post:
      summary: This API will provide insight regarding roaming status of targeted customer
      operationId: roamingStatus
      parameters:
      - in: header
        name: api_key
        example: e688u2hgpkzjd244wecywwv8
        description: API Key / Package Key from Digihub
        required: true
        schema:
          type: string
      - in: header
        name: x-signature
        example: ff080f3200a5945deeb59ad65e2b33788f5df49066a82afcf8b6d5bf43ff76ea
        description: SHA256 (API Key + Secret Key + timeStamp). [More info](https://digihub.telkomsel.com/documentation/consumer-guide/api-authentication)
        required: true
        schema:
          type: string
      - in: header
        name: Content-Type
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - transaction
              - consent
              properties:
                transaction:
                  type: object
                  required:
                  - trx_id
                  - command
                  properties:
                    trx_id:
                      type: string
                      example: 040520181127010000
                    command:
                      type: string
                      example: isRoaming
                consent:
                  type: object
                  required:
                  - msisdn
                  - consent_id;
                  - code
                  properties:
                    msisdn:
                      type: string
                      example: '62811917671'
                    consent_id:
                      type: string
                      example: O3K6lE674dF4sVE/SqcYS1zT2ENoDxU/VB6bNWPmpGbLgjqkgIdJkNg=
                    code:
                      type: string
                      example: 3erthdxb299n4dg2ue74xv4s
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: status
                    type: string
                    example: '00'
                  message:
                    description: message
                    type: string
                    example: Success
                  trx_id:
                    description: trx_id
                    type: string
                    example: 040520181127010000
                  result:
                    description: result
                    type: string
                    example: 'YES'
        '400':
          description: Invalid MSISDN / Customer not active / Parameter Param is invalid format
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: status
                    type: string
                    example: '20'
                  message:
                    description: message
                    type: string
                    example: Invalid MSISDN
                  trx_id:
                    description: trx_id
                    type: string
                    example: 040520181127010000
                  result:
                    description: result
                    type: string
                    example: ''
              examples:
                Invalid MSISDN:
                  value:
                    status: '20'
                    message: Invalid MSISDN
                    trx_id: 040520181127010000
                    result: ''
                Customer not active:
                  value:
                    status: '17'
                    message: Customer not active
                    trx_id: 040520181127010000
                    result: ''
                Parameter Param is invalid format:
                  value:
                    status: '21'
                    message: Parameter Param is invalid format
                    trx_id: 040520181127010000
                    result: ''
      tags:
      - Subscriber Check
      externalDocs:
        description: 'DigiHub endpoint reference: API Roaming Status'
        url: https://digihub.telkomsel.com/apis/V2/endpoint/133
  /digihub/subscheck/callforward:
    servers:
    - url: https://digihub.telkomsel.com
    post:
      summary: This API will provide insight regarding call forwarding status of targeted customer
      operationId: callForwarding
      parameters:
      - in: header
        name: api_key
        example: e688u2hgpkzjd244wecywwv8
        description: API Key / Package Key from Digihub
        required: true
        schema:
          type: string
      - in: header
        name: x-signature
        example: ff080f3200a5945deeb59ad65e2b33788f5df49066a82afcf8b6d5bf43ff76ea
        description: SHA256 (API Key + Secret Key + timeStamp). [More info](https://digihub.telkomsel.com/documentation/consumer-guide/api-authentication)
        required: true
        schema:
          type: string
      - in: header
        name: Content-Type
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - transaction
              - consent
              properties:
                transaction:
                  type: object
                  required:
                  - trx_id
                  - command
                  properties:
                    trx_id:
                      type: string
                      example: 040520181127010000
                    command:
                      type: string
                      example: isCallForwardActive
                consent:
                  type: object
                  required:
                  - msisdn
                  - consent_id;
                  - code
                  properties:
                    msisdn:
                      type: string
                      example: '62811917671'
                    consent_id:
                      type: string
                      example: O3K6lE674dF4sVE/SqcYS1zT2ENoDxU/VB6bNWPmpGbLgjqkgIdJkNg=
                    code:
                      type: string
                      example: 3erthdxb299n4dg2ue74xv4s
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: status
                    type: string
                    example: '00'
                  message:
                    description: message
                    type: string
                    example: Success
                  trx_id:
                    description: trx_id
                    type: string
                    example: 040520181127010000
                  result:
                    description: result
                    type: string
                    example: 'YES'
        '400':
          description: Invalid MSISDN / Customer not active / Parameter Param is invalid format
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                - trx_id
                - result
                properties:
                  status:
                    description: status
                    type: string
                    example: '20'
                  message:
                    description: message
                    type: string
                    example: Invalid MSISDN
                  trx_id:
                    description: trx_id
                    type: string
                    example: 040520181127010000
                  result:
                    description: result
                    type: string
                    example: ''
              examples:
                Invalid MSISDN:
                  value:
                    status: '20'
                    message: Invalid MSISDN
                    trx_id: 040520181127010000
                    result: ''
                Customer not active:
                  value:
                    status: '17'
                    message: Customer not active
                    trx_id: 040520181127010000
                    result: ''
                Parameter Param is invalid format:
                  value:
                    status: '21'
                    message: Parameter Param is invalid format
                    trx_id: 040520181127010000
                    result: ''
      tags:
      - Subscriber Check
      externalDocs:
        description: 'DigiHub endpoint reference: API Call Forwarding Status'
        url: https://digihub.telkomsel.com/apis/V2/endpoint/132
  /digihub/subscheck/recyclev2:
    post:
      summary: Recycle v2
      operationId: Recycle-v2
      description: This API will allow user to know if a MSISDN has been recycled or not by comparing a user’s last activation/registered time with last deactivation time in Telkomsel’s system.
      parameters:
      - in: header
        name: api_key
        example: '[api_key]'
        description: API Key / Package Key from Digihub
        required: true
        schema:
          type: string
      - in: header
        name: x-signature
        example: '[x-signature]'
        description: SHA256 (API Key + Secret Key + timeStamp). [More info](https://digihub.telkomsel.com/documentation/consumer-guide/api-key-api-secret)
        required: true
        schema:
          type: string
      - in: header
        name: Content-Type
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - transaction
              - parameter
              properties:
                transaction:
                  type: object
                  properties:
                    transaction_id:
                      description: Transaction ID
                      type: string
                      example: '1643624695_00000001'
                    consent_id:
                      description: Customer consent id
                      type: string
                      example: consent_01
                    msisdn:
                      description: MSISDN starts with “62” for Indonesia calling code
                      type: string
                      example: '628111334960'
                parameter:
                  type: object
                  properties:
                    timestamp:
                      description: Timestamp with “yyyy-mm-dd” format and not greater than current date
                      type: string
                      example: '2021-01-01'
                    channel:
                      description: Channel name, for external TSEL please use “marketplace” as the value
                      type: string
                      example: partner_01
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction_id
                - status_code
                - status_desc
                - result
                properties:
                  transaction_id:
                    description: Transaction ID.
                    type: string
                    example: '1643624695_00000187'
                  status_code:
                    description: Status Code
                    type: string
                    example: '00000'
                  status_desc:
                    description: Status Description
                    type: string
                    example: Success
                  result:
                    description: Result of whether msisdn is recycled or not.
                    type: string
                    example: 'NO'
        '400':
          description: Empty Mandatory Parameter / Invalid MSISDN / Invalid Timestamp
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction_id
                - status_code
                - status_desc
                properties:
                  transaction_id:
                    description: Transaction ID
                    type: string
                    example: C002190726165745657448250
                  status_code:
                    description: Status Code
                    type: string
                    example: '20101'
                  status_desc:
                    description: Status Description
                    type: string
                    example: Invalid Timestamp
              examples:
                Empty Mandatory Parameter:
                  value:
                    transaction_id: C002190726165745657448250
                    status_code: '20001'
                    status_desc: Empty mandatory parameter
                Invalid MSISDN:
                  value:
                    transaction_id: C002190726165745657448250
                    status_code: '20002'
                    status_desc: INVALID MSISDN
                Invalid Timestamp:
                  value:
                    transaction_id: C002190726165745657448250
                    status_code: '20101'
                    status_desc: Invalid Timestamp
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction_id
                - status_code
                - status_desc
                properties:
                  transaction_id:
                    description: Transaction ID
                    type: string
                    example: C002190726165745657448250
                  status_code:
                    description: Status Code
                    type: string
                    example: '20101'
                  status_desc:
                    description: Status Description
                    type: string
                    example: Invalid Timestamp
              example:
                transaction_id: C002190726165745657448250
                status_code: '40000'
                status_desc: ESB Internal Error
        '502':
          description: Backend Internal Error
          content:
            application/json:
              schema:
                type: object
                required:
                - transaction_id
                - status_code
                - status_desc
                properties:
                  transaction_id:
                    description: Transaction ID
                    type: string
                    example: C002190726165745657448250
                  status_code:
                    description: Status Code
                    type: string
               

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telkomsel/refs/heads/main/openapi/telkomsel-subscriber-check-api-openapi.yml