> For the complete documentation index, see [llms.txt](https://wadocs.pepipost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wadocs.pepipost.com/sending-message/consent-api.md).

# Consent API

This endpoint to check that user has taken opt-in or not. 

**URL:**&#x200B; <https://waapi.pepipost.com/api/v2/consent/>&#x20;

**Method:** POST

### Parameters:

| Parameter     | Description                                                | Data Type | Required |
| ------------- | ---------------------------------------------------------- | --------- | -------- |
| phone\_number | Provide the phone number which you have used while opt-in. | String    | Yes      |

### Request Body

```
{ 
    "phone_number":"919999999999", 
} 
```

### Responses

&#x20;**In case of Success :**

```
{ 
    "status": "success", 
    "data": { 
        "ip": "192.168.7.26", 
        "phone_number": "919999999999", 
        "optin_source": "6465466", 
        "user_agent": "Mozilla", 
        "created_date": "2019-04-22 15:36:01.0" 
    } 
} 
```

Status is success means optin added successfully.

**In case of failure:**

```
{ 
    "status": "failure", 
    "error": { 
        "message": "Optin details not found for 919999999999" 
    } 
} 
```

According to error, code and message will change.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wadocs.pepipost.com/sending-message/consent-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.