Claim by identifier

Information

---

Use this endpoint to assert that a specific business entity, identified by its identifier, is managed by you.

By using this endpoint, you establish a relationship between your account and the business entity, indicating that the business entity is under your management.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

---

POST/v1/config/business/entity/scheme/{identifierScheme}/value/{identifierValue}/claim

---

Path parameters

---

identifierSchemestring - Required

---

identifierValuestring - Required

Value associated with the identifier (e.g., 'SIREN').

---

Body parameters

---

It can be useful for webhooks. When we call you, we will include this additional data.

dataobject

Any kind of specific data

directionenum

Direction of the stream. "INBOUND" for inbound, "OUTBOUND" for outbound, null for both

---

Request

---

POST /v1/config/business/entity/scheme/:identifierScheme/value/:identifierValue/claim

bash

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/config/business/entity/scheme/0002/value/123456789/claim'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${TOKEN}'

javascript

    const got = require('got');
    const url = 'https://api.ppd.iopole.fr//v1/config/business/entity/scheme/0002/value/123456789/claim';
    const token = 'your_token_here';
    (async () => {
        try {
        const response = await got(url, {
            headers: {
                    accept: 'application/json',
                    Authorization: `Bearer ${token}`,
            },
                responseType: 'json',
            });
         console.log(response.body);
        } catch (error) {
            console.error('Error:', error.message);
        }
    })();

.NET

    using System;
    using System.Net.Http;
    using System.Net.Http.Headers;
    using System.Threading.Tasks;
    class Program
    {
        static async Task Main(string[] args)
        {
        string url = "https://api.ppd.iopole.fr//v1/config/business/entity/scheme/0002/value/123456789/claim";
        string token = "your_token_here";
        using HttpClient client = new HttpClient();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
        try
        {
            HttpResponseMessage response = await client.GetAsync(url);
            response.EnsureSuccessStatusCode();
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine("Error: {e.Message}");
        }
    }
    }

Response

---

Status: 201 - application/json

Description: Business entity configuration done

Schema:

• type: enum
  The type of the response object.
• id: string
  The unique identifier for the created element.

Examples:

{
  "type": "BUSINESS_ENTITY",
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.

---