# Checking Subscription Status (API)

You can also check your users subscription status via our RESTFul api with the following **POST** request: 

{% tabs %}
{% tab title="Request" %}

```
https://subscription-api.mobivate.com/subscriptions/v1/<campaign_id>/status
```

{% endtab %}

{% tab title="JSON Body" %}

```json
{
    "msisdn":"xxxxxxxxxxx"
    "signature":"xxxxxxxxxxxxxxxxxx"
}
```

{% endtab %}
{% endtabs %}

### Parameters

The only parameter required for the request is the statuses you check.

| Parameter | Description                                                                                                                                      |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| status    | The statuses you want to check, for example: `active`, `inactive`, `nf`, `nfi`, `ping`, `onhold`, `blocked`, r`einvite` and `doi-onhold`         |
| msisdn    | The unique **MSISDN** you are trying to unsubscribe.                                                                                             |
| signature | Unique parameter consisting of three values: **campaign\_id**, **msisdn** and **account\_id**. For example:  `1af289e14aa593c843da7cd869a8e2f7`. |

{% hint style="info" %}
**Please note:** You can include multiple statuses in your request, for example: `'active', 'inactive'` etc.
{% endhint %}

### Successful response

If your user's status has been checked successfully you will receive the following response, **HTTP Status Code 200**:

```json
{
  "authenticated" : True,
  "valid_ " : True,
  "valid_campaign" : True,
  "campaign_status" : "active",
  "campaign_name" : "Test Campaign",
  "campaign_service" : "12345",
  "state" : ('active','inactive','nf','nfi','ping','onhold','blocked','reinvite','doi-onhold',
  'doi-declined','suspended','investigate','unsub'),
  "error" : Null,
  "reference": "AP:aaaaaaa-bbbbbbbbb-cccccccc"
}
```