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

# Set or change a person's transaction PIN

PUT https://tenant.api.corpx.com/v1/people/pin
Content-Type: application/json

The PIN belongs to the person (`X-Acting-Document`) inside the tenant,
and is the same PIN on every account that person operates. Requires
scope `pin.manage`. The CPF is a header, not a path segment: API
Gateway access logs store the path.

The first enrollment does not send `currentPin`. Replacing an existing
PIN requires `currentPin`. When hosted reset is on, a replacement
without `currentPin` returns **403** `pin_change_disabled`; a
replacement with the correct `currentPin` succeeds. After `DELETE`, a
PUT without `currentPin` re-enrolls only while hosted reset is off.


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

## 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.
- `Idempotency-Key` (string, optional) — Optional client-generated idempotency token (recommended for safe retries).

### Body (application/json)

This endpoint expects an object.

- `pin` (string, required)
- `currentPin` (string, optional) — Required when replacing an existing PIN.

## Response

### 200

PIN created, replaced or re-enrolled.

- `document` (string, optional) — Masked CPF.
- `status` (enum, optional)
  - Allowed values: `set`, `changed`, `reenrolled`

## Errors

### 403 Forbidden Error

`pin_invalid` or `pin_change_disabled`.

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

### 422 Unprocessable Entity Error

`weak_pin`.

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

### 423 Locked Error

`pin_locked` when the PIN is hard-locked by failed attempts. An invalidated PIN is not this case.

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

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

**Request**

```json
{
  "pin": "482913",
  "currentPin": "482913"
}
```

**Response**

```json
{
  "document": "***.***.***-25",
  "status": "set"
}
```

**SDK Code**

```python People_setPersonTransactionPin_example
import requests

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

payload = {
    "pin": "482913",
    "currentPin": "482913"
}
headers = {
    "X-Acting-Document": "X-Acting-Document",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript People_setPersonTransactionPin_example
const url = 'https://tenant.api.corpx.com/v1/people/pin';
const options = {
  method: 'PUT',
  headers: {
    'X-Acting-Document': 'X-Acting-Document',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"pin":"482913","currentPin":"482913"}'
};

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

```go People_setPersonTransactionPin_example
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"pin\": \"482913\",\n  \"currentPin\": \"482913\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Acting-Document", "X-Acting-Document")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

```ruby People_setPersonTransactionPin_example
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-Acting-Document"] = 'X-Acting-Document'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pin\": \"482913\",\n  \"currentPin\": \"482913\"\n}"

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

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

HttpResponse<String> response = Unirest.put("https://tenant.api.corpx.com/v1/people/pin")
  .header("X-Acting-Document", "X-Acting-Document")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pin\": \"482913\",\n  \"currentPin\": \"482913\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://tenant.api.corpx.com/v1/people/pin', [
  'body' => '{
  "pin": "482913",
  "currentPin": "482913"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Acting-Document' => 'X-Acting-Document',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

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

```csharp People_setPersonTransactionPin_example
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/people/pin");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-Acting-Document", "X-Acting-Document");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"pin\": \"482913\",\n  \"currentPin\": \"482913\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift People_setPersonTransactionPin_example
import Foundation

let headers = [
  "X-Acting-Document": "X-Acting-Document",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "pin": "482913",
  "currentPin": "482913"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/people/pin")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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