> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.goodflag.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.goodflag.com/_mcp/server.

# Consulter une page de consentement

GET https://workflow-manager/api/consentPages/{consentPageId}

Renvoie une page de consentement existante.

`consentPageManager`

Également autorisés sans rôle : tout utilisateur du tenant.

Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/consent-pages/retrieve-consent-page

## Authentication

- `Authorization` header (bearer token, required) — Authentification Bearer par jeton utilisateur ou jeton d'accès : `Authorization: Bearer <token>`.

## Request

### Path parameters

- `consentPageId` (string, required) — L'identifiant de la page de consentement.

## Response

### 200

Consulter une page de consentement

- `stepType` (enum, required) — Le type d'étapes avec lesquelles la page de consentement peut être utilisée : signature ou approval.
  - Allowed values: `approval`, `signature`
- `signingMode` (enum, required) — Le mode de signature de cette page de consentement. Valeurs possibles : server, local.
  - Allowed values: `local`, `server`
- `allowOrganization` (boolean, required) — Indique si les signataires peuvent signer en tant que représentant légal d'une organisation.
- `authenticateUser` (boolean, required) — Indique si l'utilisateur est authentifié auprès du fournisseur d'identité avant d'accéder aux documents.
- `clientId` (string, required) — L'identifiant client de la page de consentement.
- `created` (long, required) — La date de création de l'entité.
- `emUrl` (string, required) — L'URL de l'Evidence Manager qui sert la page de consentement.
- `hideDownloads` (boolean, required) — Masque les boutons de téléchargement.
- `hideMobileQrCode` (boolean, required) — Masque le QR code Odisia Mobile.
- `id` (string, required) — L'identifiant de la page de consentement.
- `isCountryRequired` (boolean, required) — Indique si le pays de l'utilisateur est requis.
- `isDisabled` (boolean, required) — Indique si la page de consentement est désactivée.
- `name` (string, required) — Le nom de la page de consentement.
- `primaryColor` (string, required) — La couleur du portail.
- `sharedPassphrase` (string, required) — La phrase secrète partagée de cette page de consentement.
- `tenantId` (string, required) — L'identifiant du tenant auquel appartient la page de consentement.
- `tsaUrl` (string, required) — Le serveur d'horodatage conforme à la RFC 3161 à utiliser lors de la signature.
- `updated` (long, required) — La date de dernière modification de l'entité.
- `verifyEmail` (boolean, required) — Indique si l'adresse email de l'utilisateur est vérifiée par un mot de passe à usage unique avant la signature.
- `verifyPhoneNumber` (boolean, required) — Indique si le numéro de téléphone de l'utilisateur est vérifié par un mot de passe à usage unique avant la signature.
- `keystoreTypes` (list of enum, optional) — Liste des types de magasins de clés utilisés par Odisia Desktop en mode de signature locale.
  - Allowed values: `OS`, `PKCS11`
- `logoResourceId` (string, optional) — L'identifiant de la ressource image du logo.
- `strictCertificateControl` (boolean, optional) — Indique si le certificat utilisé lors d'une signature locale doit correspondre aux informations de l'utilisateur.
- `jobOperation` (string, optional) — L'opération de tâche en cours d'exécution.

## Errors

### 403 Forbidden Error

AuthenticatedUserDisabled : L'utilisateur authentifié est désactivé. ; MissingBearerToken : Un jeton Bearer est requis. ; TenantInactive : Le tenant est inactif et n'autorise aucune opération. ; UserGroupDisabled : Le groupe de l'utilisateur spécifié est désactivé. ; UserNotAllowed : L'utilisateur authentifié n'est pas autorisé à effectuer cette opération.

- `status` (integer, required) — Le code de statut HTTP.
- `error` (string, required) — Le message de statut HTTP.
- `message` (string, required) — Le message d'erreur.
- `code` (string, required) — Le code d'erreur.

### 404 Not Found Error

ConsentPageNotFound : La page de consentement spécifiée est introuvable.

- `status` (integer, required) — Le code de statut HTTP.
- `error` (string, required) — Le message de statut HTTP.
- `message` (string, required) — Le message d'erreur.
- `code` (string, required) — Le code d'erreur.

## Examples

**Response**

```json
{
  "stepType": "signature",
  "signingMode": "server",
  "allowOrganization": true,
  "authenticateUser": false,
  "clientId": "clt01",
  "created": 1782821280796,
  "emUrl": "https://evidence-manager.lex-persona.com/",
  "hideDownloads": false,
  "hideMobileQrCode": true,
  "id": "cop_AfGTsGSh1mmatSUL5AWFo2Do",
  "isCountryRequired": false,
  "isDisabled": false,
  "name": "Cyan",
  "primaryColor": "#208cdf",
  "sharedPassphrase": "****************",
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "tsaUrl": "https://tsa.sunnystamp.com/tsa",
  "updated": 1782821280796,
  "verifyEmail": false,
  "verifyPhoneNumber": false,
  "logoResourceId": "res_mHJdVK9q7uKstGgs9RK1xCvg"
}
```

**SDK Code**

```python Requête réussie.
import requests

url = "https://workflow-manager/api/consentPages/consentPageId"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Requête réussie.
const url = 'https://workflow-manager/api/consentPages/consentPageId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Requête réussie.
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://workflow-manager/api/consentPages/consentPageId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Requête réussie.
require 'uri'
require 'net/http'

url = URI("https://workflow-manager/api/consentPages/consentPageId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Requête réussie.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://workflow-manager/api/consentPages/consentPageId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Requête réussie.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://workflow-manager/api/consentPages/consentPageId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Requête réussie.
using RestSharp;

var client = new RestClient("https://workflow-manager/api/consentPages/consentPageId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Requête réussie.
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/consentPages/consentPageId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```