> This page is for BaaS.

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

# List individual accreditations (Pessoa Física)

GET https://tenant.api.corpx.com/v1/accreditations/pf

Returns individual (PF) accreditations for the tenant, most recent first. **BaaS integrators only.**

Reference: https://docs.api.corpx.com/baas/referencia/accreditations/list-accreditations-pf

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `document` (string, optional) — Filter by CPF (11 digits, no punctuation).
- `status` (enum, optional) — Filter by accreditation status (case-insensitive).
  - Allowed values: `PENDING_BIOMETRY`, `PENDING_CONSENT`, `BIOMETRY_APPROVED`, `PENDING_REVIEW`, `INTEGRATING`, `ACTIVE`, `FAILED`
- `limit` (integer, optional, default: 20) — Maximum number of items to return (page size).
- `offset` (integer, optional, default: 0) — Number of items to skip before the first returned item (pagination).

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.

## Response

### 200

List of individual accreditations returned successfully.

- `items` (list of AccreditationDetail, optional)
- `total` (integer, optional)
- `limit` (integer, optional)
- `offset` (integer, optional)

## Errors

### 400 Bad Request Error

Invalid request sent by client.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 500 Internal Server Error

Unexpected server error.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### AccreditationDetail

- `accreditationId` (string, optional)
- `accountId` (string, optional) — Account id — usable in all banking endpoints once status is ACTIVE.
- `type` (enum, optional)
  - Allowed values: `pf`, `pj`
- `document` (string, optional)
- `status` (enum, optional) — Accreditation lifecycle status.
  - Allowed values: `PENDING_BIOMETRY`, `PENDING_CONSENT`, `BIOMETRY_APPROVED`, `PENDING_REVIEW`, `INTEGRATING`, `ACTIVE`, `FAILED`
- `biometryMode` (enum, optional) — unico = CorpX-managed facial biometrics (default); external = provider enabled by CorpX on request.
  - Allowed values: `unico`, `external`
- `legalForm` (enum, optional) — PJ only — corporate form from create.
  - Allowed values: `mei`, `ltda`, `sa`, `cooperative`
- `documents` (list of AccreditationCompanyDocument, optional) — PJ only — uploaded company PDFs.
- `requiredDocumentKinds` (list of enum, optional) — PJ only — kinds required for this legalForm (operator approve gate).
  - Allowed values: `company_articles`, `company_proof_of_address`, `cnpj_card`, `financial_statements`, `business_license`, `regulatory_license`, `account_opening_terms`, `other`
- `missingDocumentKinds` (list of enum, optional) — PJ only — required kinds not yet uploaded.
  - Allowed values: `company_articles`, `company_proof_of_address`, `cnpj_card`, `financial_statements`, `business_license`, `regulatory_license`, `account_opening_terms`, `other`
- `documentsOverride` (boolean, optional) — true when an operator forced approve with incomplete docs.
- `documentsOverrideBy` (string, optional)
- `documentsOverrideReason` (string, optional)
- `documentsOverrideMissing` (list of string, optional)
- `documentsOverrideAt` (datetime, optional)
- `callbackUri` (string, optional) — Optional. Where to send the account holder back to when the step is finished (facial capture, terms acceptance or portability authorization). Without it the holder ends on a CorpX completion page, as before. The URI must be registered for your tenant by CorpX support before the first use, and the match is **exact** — no wildcards, no prefix matching. An unregistered URI is rejected at creation time with `400 invalid_callback_uri`. Accepted: `https://` and your application's own scheme (deeplink). Rejected: `http://`, `javascript:`, `data:`, `file:`, credentials in the URI, fragments (`#`), `localhost`, private/link-local IP ranges and internal suffixes (`.local`, `.internal`). On return, CorpX appends `accreditationId`, `outcome`, `personId` (for per-person steps) and `remainingPeople` (when the accreditation has more than one person). **These parameters are not proof of anything**: they travel in the address bar and the holder can edit them. Any decision with an effect must rely on the webhook or on `GET /v1/accreditations/{accreditationId}`.
- `persons` (list of AccreditationPersonView, optional)
- `errorReason` (string, optional)
- `errorMessage` (string, optional)
- `partner` (AccreditationDetailPartner, optional) — Raw refusal from the banking provider, present only when a `FAILED` accreditation was refused by it. It is the same block delivered in the `accreditation.failed` webhook — the query never shows less than the webhook. `code`, `message` and `field` are the item the catalog recognized, or `message` alone when none of the provider's codes was recognized. `errors` lists every item the provider sent, in its order, with the same three keys. Every key is optional: some refusals carry `message` only, and an accreditation refused before `errors` existed has no list. Informative — branch your code on `errorReason`, not on this.
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

### AccreditationCompanyDocument

- `documentId` (string, optional)
- `kind` (enum, optional)
  - Allowed values: `company_articles`, `company_proof_of_address`, `cnpj_card`, `financial_statements`, `business_license`, `regulatory_license`, `account_opening_terms`, `other`
- `fileName` (string, optional)
- `deliveryStatus` (enum, optional) — pending_upload means the slot exists but no file was PUT. Only delivered fulfils the requirement.
  - Allowed values: `pending_upload`, `scanning`, `delivered`, `rejected`
- `uploadedAt` (datetime, optional) — Present only when deliveryStatus is delivered.
- `sizeBytes` (long, optional) — Present only when deliveryStatus is delivered.

### AccreditationPersonView

Per-person biometrics/acceptance progress.

- `personId` (string, optional) — Stable identifier of this person inside the accreditation. It is the value returned in the `personId` parameter of the `callbackUri` redirect — the CPF is never placed in a URI that ends up in browser history and proxy logs.
- `cpf` (string, optional)
- `name` (string, optional)
- `biometryStatus` (enum, optional)
  - Allowed values: `PENDING`, `APPROVED`, `FAILED`, `EXPIRED`
- `biometryLink` (string, optional) — Facial capture link (default Unico flow). May be absent right after creation — it is delivered via the `accreditation.biometry.link.created` webhook as soon as it is issued.
- `acceptanceStatus` (string, optional) — External biometrics flow only (PENDING, ACCEPTED, DENIED).
- `acceptanceLink` (string, optional) — Terms acceptance page URL (external biometrics flow only). Built from the stored token; may be absent right after creation — also delivered via `accreditation.acceptance.link.created`.
- `consentStatus` (enum, optional) — Present only when the CPF already has an account and the tenant has automatic portability enabled (status `PENDING_CONSENT`). There is no new account to open: the account holder must authorize this tenant to operate the existing account.
  - Allowed values: `PENDING`, `ACCEPTED`, `DECLINED`, `DENIED`, `EXPIRED`
- `consentLink` (string, optional) — Authorization page URL — deliver it to the account holder. The page requires an identity verification (live selfie checked against official records by CPF) and discloses account number and current balance before the authorization. Also delivered via `accreditation.consent.link.created`.
- `consentExpiresAt` (datetime, optional) — Consent link expiry (7 days). The journey expires after 30 days.
- `linkExpiresAt` (datetime, optional)

### AccreditationDetailPartner

Raw refusal from the banking provider, present only when a `FAILED` accreditation was refused by it. It is the same block delivered in the `accreditation.failed` webhook — the query never shows less than the webhook. `code`, `message` and `field` are the item the catalog recognized, or `message` alone when none of the provider's codes was recognized. `errors` lists every item the provider sent, in its order, with the same three keys. Every key is optional: some refusals carry `message` only, and an accreditation refused before `errors` existed has no list. Informative — branch your code on `errorReason`, not on this.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional)
- `errors` (list of AccreditationDetailPartnerErrorsItems, optional) — Every item from the provider's error list, in the order it sent them. `code`, `message` and `field` above stay the recognized item.

### AccreditationDetailPartnerErrorsItems

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional)

## Examples

**Response**

```json
{
  "items": [
    {
      "accreditationId": "acr_9f8e7d6c5b4a",
      "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
      "type": "pf",
      "document": "12345678900",
      "status": "PENDING_BIOMETRY",
      "biometryMode": "unico",
      "legalForm": "mei",
      "documents": [
        {
          "documentId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
          "kind": "company_articles",
          "fileName": "MARIA DA SILVA",
          "deliveryStatus": "pending_upload",
          "uploadedAt": "2026-02-20T08:33:39Z",
          "sizeBytes": 50
        }
      ],
      "requiredDocumentKinds": [
        "company_articles"
      ],
      "missingDocumentKinds": [
        "company_articles"
      ],
      "documentsOverride": true,
      "documentsOverrideBy": "12345678900",
      "documentsOverrideReason": "12345678900",
      "documentsOverrideMissing": [
        "12345678900"
      ],
      "documentsOverrideAt": "2026-02-20T08:33:39Z",
      "callbackUri": "https://app.yourcompany.com/onboarding/done",
      "persons": [
        {
          "personId": "prs_3b1c9a7f2e4d",
          "cpf": "12345678900",
          "name": "MARIA DA SILVA",
          "biometryStatus": "PENDING",
          "biometryLink": "https://onboarding.corpx.com/c/8c1f6a2e",
          "acceptanceStatus": "COMPLETED",
          "acceptanceLink": "https://onboarding.corpx.com/c/8c1f6a2e",
          "consentStatus": "PENDING",
          "consentLink": "https://onboarding.corpx.com/c/8c1f6a2e",
          "consentExpiresAt": "2026-02-20T08:33:39Z",
          "linkExpiresAt": "2026-02-20T08:33:39Z"
        }
      ],
      "partner": {
        "code": "request.body.invalid",
        "message": "A solicitação é inválida: O número não pode exceder 10 caracteres.",
        "field": "address.number"
      },
      "createdAt": "2026-02-20T08:33:39Z",
      "updatedAt": "2026-02-20T08:33:39Z"
    }
  ],
  "total": 150,
  "limit": 50,
  "offset": 0
}
```

**SDK Code**

```python Accreditations_listAccreditationsPf_example
import requests

url = "https://tenant.api.corpx.com/v1/accreditations/pf"

headers = {
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

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

print(response.json())
```

```javascript Accreditations_listAccreditationsPf_example
const url = 'https://tenant.api.corpx.com/v1/accreditations/pf';
const options = {
  method: 'GET',
  headers: {'X-Tenant-Id': 'X-Tenant-Id', Authorization: 'Bearer <token>'}
};

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

```go Accreditations_listAccreditationsPf_example
package main

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

func main() {

	url := "https://tenant.api.corpx.com/v1/accreditations/pf"

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

	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	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 Accreditations_listAccreditationsPf_example
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/accreditations/pf")

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

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

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

```java Accreditations_listAccreditationsPf_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://tenant.api.corpx.com/v1/accreditations/pf")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Accreditations_listAccreditationsPf_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://tenant.api.corpx.com/v1/accreditations/pf', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

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

```csharp Accreditations_listAccreditationsPf_example
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accreditations/pf");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Accreditations_listAccreditationsPf_example
import Foundation

let headers = [
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/accreditations/pf")! 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()
```