> For the complete documentation index, see [llms.txt](https://doc.sideos.io/sideos-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.sideos.io/sideos-api-documentation/reference/api-reference/request-credentials.md).

# Request Credentials

## Introduction

If an organisation wants to get verifiable data from a user, e.g. to authenticate a web user, the organisation can use the sideos API to create a request for Verifiable Credentials from an SSI wallet. If the SSI wallet has the requested credential types available, it will respond with the verifiable credentials if authorised by the user.

Like in the Offer flow, also in the Request flow there are 3 parties: 

1. **SSI wallet**. Interacts, stores, and manages verifiable credentials.
2. **Web Service**. Role of the Verifier requesting verifiable credentials from the SSI wallet.
3. **sideos API**. Creates the request of verifiable credentials on behalf of the verifier.

sideos provides an **SSI wallet** available as <mark style="color:purple;">**sideos**</mark> <mark style="color:purple;">**Transponder App**</mark> for Android in Google Play Store, for iOS in Apple's App Store, and as <mark style="color:green;">**sideos Desktop Wallet**</mark> for Chrome, Firefox, and Safari.&#x20;

The **Web Service** is your server you will integrate with the sideos API. The **Web Server** will interact with the **SSI wallet** and control the flow depending on the business requirements. To verify a credential the **Web Service** creates a request for verifiable credential types that will be compiled by the **sideos API**, and in return receives the request data structure for ask for the respective verifiable credentials that should be shardd by the **SSI wallet**. &#x20;

## Request Flow

See the diagram below for the flow chart for a credential request.&#x20;

<figure><img src="/files/Uwk1ctuFJ9i12IBMPCKZ" alt=""><figcaption></figcaption></figure>

{% openapi src="/files/TUJSrKLnC1vO18Fc67G8" path="/createrequestvc" method="post" %}
[sideosAPIv3.yaml](https://1845885721-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbCooZXcPwZpoBiEXpWdN%2Fuploads%2FRRSfdtZvMJzTR29xfgju%2FsideosAPIv3.yaml?alt=media\&token=7827e8ae-2798-450a-a4f9-44d845ba3fd9)
{% endopenapi %}

{% openapi src="/files/TUJSrKLnC1vO18Fc67G8" path="/consumerequest" method="post" %}
[sideosAPIv3.yaml](https://1845885721-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbCooZXcPwZpoBiEXpWdN%2Fuploads%2FRRSfdtZvMJzTR29xfgju%2FsideosAPIv3.yaml?alt=media\&token=7827e8ae-2798-450a-a4f9-44d845ba3fd9)
{% endopenapi %}


---

# 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, and the optional `goal` query parameter:

```
GET https://doc.sideos.io/sideos-api-documentation/reference/api-reference/request-credentials.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.