Orange KYC Match Python API Docs | dltHub

Orange KYC Match – CAMARA API is a service that validates a user's identity attributes by matching them against KYC data held by mobile network operators. The REST API base URL is https://api.orange.com/camara/ofr/kyc-match/v0.2 and All requests require a Bearer access token obtained via CIBA OAuth..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Orange KYC Match data in under 10 minutes.

---

What data can I load from Orange KYC Match?

Here are some of the endpoints you can load from Orange KYC Match:

---

How do I authenticate with the Orange KYC Match API?

The API uses CIBA 3‑legged OAuth to obtain a Bearer access token. Every request must include the header Authorization: Bearer {access_token}.

1. Get your credentials

1. POST to https://api.orange.com/es/openapi/oauth/v2/bc-authorize with client credentials to obtain an auth_req_id.
2. Poll https://api.orange.com/es/openapi/oauth/v2/token using the auth_req_id until an access_token is returned.
3. Store the access_token and use it in the Authorization: Bearer header for API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.orange_kyc_match_source]
access_token = "your_access_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Orange KYC Match API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python orange_kyc_match_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline orange_kyc_match_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset orange_kyc_match_data
The duckdb destination used duckdb:/orange_kyc_match.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline orange_kyc_match_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads match and health from the Orange KYC Match API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def orange_kyc_match_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.orange.com/camara/ofr/kyc-match/v0.2",
            "auth": {
                "type": "bearer",
                "access_token": access_token,
            },
        },
        "resources": [
            {"name": "match", "endpoint": {"path": "match"}},
            {"name": "health", "endpoint": {"path": "health"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="orange_kyc_match_pipeline",
        destination="duckdb",
        dataset_name="orange_kyc_match_data",
    )
    load_info = pipeline.run(orange_kyc_match_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("orange_kyc_match_pipeline").dataset()
sessions_df = data.match.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM orange_kyc_match_data.match LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("orange_kyc_match_pipeline").dataset()
data.match.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Orange KYC Match data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication errors

If the Bearer token is missing, expired, or invalid, the API returns 401 Unauthorized with an error object containing a code and message describing the authentication failure.

Validation errors

When required request fields are absent or malformed, the service responds with 400 Bad Request and provides an error model { "code": ..., "message": ..., "description": ... } detailing the problem.

Server errors

Unexpected conditions result in 5xx responses. The error payload follows the same structure as above.

Note: Pagination quirks and rate‑limit details were not found in the provided documentation.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack