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

# Read a person's PIN lockout state

GET https://tenant.api.corpx.com/v1/people/pin/status

One object for the CPF in `X-Acting-Document`. `set` is false when the
person has no PIN. The document comes back masked. Requires scope
`pin.manage`.


Reference: https://en.docs.api.corpx.com/baas/referencia/people/get-person-transaction-pin-status

## Authentication

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

## Request

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `X-Acting-Document` (string, required) — CPF of the person, 11 digits.

## Response

### 200

Lockout state and the effective policy.

- `document` (string, optional)
- `set` (boolean, optional)
- `failedAttempts` (integer, optional)
- `locked` (boolean, optional)
- `lockedUntil` (datetime, optional, nullable)
- `requiresReset` (boolean, optional)
- `setAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `policy` (V1PeoplePinStatusGetResponsesContentApplicationJsonSchemaPolicy, optional) — Effective PIN policy (length, lockout thresholds).

## Errors

### 400 Bad Request Error

`invalid_document` or `missing_tenant`.

- `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

### V1PeoplePinStatusGetResponsesContentApplicationJsonSchemaPolicy

Effective PIN policy (length, lockout thresholds).

### 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.

## Examples

**Response**

```json
{
  "document": "***.***.***-25",
  "set": true,
  "failedAttempts": 0,
  "locked": false,
  "lockedUntil": null,
  "requiresReset": false,
  "setAt": "2026-10-07T18:00:00Z",
  "updatedAt": "2026-10-07T18:00:00Z"
}
```

**SDK Code**

```python People_getPersonTransactionPinStatus_example
import requests

url = "https://tenant.api.corpx.com/v1/people/pin/status"

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

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

print(response.json())
```

```javascript People_getPersonTransactionPinStatus_example
const url = 'https://tenant.api.corpx.com/v1/people/pin/status';
const options = {
  method: 'GET',
  headers: {
    'X-Acting-Document': 'X-Acting-Document',
    '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 People_getPersonTransactionPinStatus_example
package main

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

func main() {

	url := "https://tenant.api.corpx.com/v1/people/pin/status"

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

	req.Header.Add("X-Acting-Document", "X-Acting-Document")
	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 People_getPersonTransactionPinStatus_example
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/people/pin/status")

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

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

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

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

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp People_getPersonTransactionPinStatus_example
using RestSharp;

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

```swift People_getPersonTransactionPinStatus_example
import Foundation

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

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