Pix key claim status changed

Pix key claim creation and/or status change. The following endpoints generate this event: Create key claim, Cancel key claim, and Complete key claim. For more information, see the Pix instant payments guide. Also see the Pix payments data events guide.

Type: object
Domain: pix-dict
Event: claim_status_change
Version: 1

correlation_id

Title: Correlation ID
Description: Use this attribute when provider returns timeout on claim creation. The correlation ID (CID) informed on the claim API creation request and events. The CID can help the Pismo engineering team track everything related to a call. You can find the CID field in the response header from an API endpoint call
Type: string
Example:
51011dc9-5ecf-49c9-9fe4-1a7b13dfaf7

account_id required

Title: Account ID
Description: Pismo account ID
Type: integer
Example:
123456

claim_id required

Title: Claim ID
Description: Pix DICT key claim ID
Type: string
Example:
999f46ae-70be-4f9b-97a1-c0695903e962

claim_origin required

Title: Claim origin
Description: Claim originator
Type: string
Max length: 7
Must be one of the following:
CLAIMER
DONOR
Example:
CLAIMER

claim_status required

Title: Claim status
Description: Pix DICT key claim status
Type: string
Max length: 20
Must be one of the following:
OPEN
WAITING_RESOLUTION
WAITING_CLOSURE
CONFIRMED
CANCELLED
COMPLETED
Example:
OPEN

claim_type required

Title: Claim type
Description: Pix key claim type
Type: string
Max length: 12
Must be one of the following:
OWNERSHIP
PORTABILITY
Example:
OWNERSHIP

key required

Title: Pix key value
Description: Pix key value of key type. For example: [email protected] (EMAIL key type)
Type: string
Max length: 77
Example:
[email protected]
12345678987

key_type required

Title: Pix key type
Description: Pix key type:
CPF - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US.
CNPJ - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil
EMAIL - Email
PHONE - Phone number
EVP - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.
Type: string
Must be one of the following:
CPF
CNPJ
PHONE
EMAIL
EVP
Example:
EMAIL

content_id

Title: Content identifier
Description: Content ID. This is a hashed value created from a number of key-related fields in the Pismo database. This is meant for you to store and send to Pismo in case there is any problem with the key.
Type: string
Max length: 64
Example:
a6506d3905962f9f00e118201a8710433406b3af87d2cc8c00a621f03a006ccd

cancel_reason

Title: Claim cancel reason
Description: Claim cancellation reason. Will be null for non-cancelled claim
Type: string
Max length: 20
Must be one of the following:
USER_REQUESTED
DEFAULT_OPERATION
FRAUD
ACCOUNT_CLOSURE
RECONCILIATION
Example:
USER_REQUESTED

confirm_reason

Title: Claim confirmation reason
Description: Claim confirmation reason. Will be null for non-confirmed claim
Type: string
Max length: 20
Must be one of the following:
USER_REQUESTED
DEFAULT_OPERATION
ACCOUNT_CLOSURE
Example:
USER_REQUESTED

resolution_period_end required

Title: Resolution period end
Description: Claim period end for the resolution. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-22T11:00:00.000Z

completion_period_end

Title: Completion period end
Description: Claim period end to be completed. Might be null for claim type PORTABILITY. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-29T11:00:00.000Z

creation_datetime required

Title: Creation Time
Description: Claim creation datetime on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-29T11:00:00.000Z

last_modified required

Title: Last modified
Description: Last modification datetime on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-29T11:00:00.000Z

acknowledge_received_at required

Title: Acknowledge received
Description: Acknowledge received on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-29T11:00:00.000Z

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Pix key claim status changed",
    "description": "Pix key claim creation and/or status change. The following endpoints generate this event:  <a href='https://developers.pismo.io/pismo-docs/reference/post-dict-key-claim'>Create key claim</a>, <a href='https://developers.pismo.io/pismo-docs/reference/postcancel-dict-claim'>Cancel key claim</a>, and <a href='https://developers.pismo.io/pismo-docs/reference/post-complete-dict-claim'>Complete key claim</a>. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/pix-instant-payments'>Pix instant payments</a> guide. Also see the <a href='https://developers.pismo.io/pismo-docs/docs/pix-payments-data-events'>Pix payments data events</a> guide.",
    "required": [
        "account_id",
        "claim_id",
        "claim_origin",
        "claim_status",
        "claim_type",
        "key",
        "key_type",
        "resolution_period_end",
        "creation_datetime",
        "last_modified",
        "acknowledge_received_at"
    ],
    "properties": {
        "correlation_id": {
            "type": "string",
            "title": "Correlation ID",
            "description": "Use this attribute when provider returns timeout on claim creation. The correlation ID (CID) informed on the claim API creation request and events. The CID can help the Pismo engineering team track everything related to a call. You can find the CID field in the response header from an API endpoint call",
            "examples": [
                "51011dc9-5ecf-49c9-9fe4-1a7b13dfaf7"
            ]
        },
        "account_id": {
            "type": "integer",
            "title": "Account ID",
            "description": "Pismo account ID",
            "examples": [
                123456
            ]
        },
        "claim_id": {
            "type": "string",
            "title": "Claim ID",
            "description": "Pix DICT key claim ID",
            "examples": [
                "999f46ae-70be-4f9b-97a1-c0695903e962"
            ]
        },
        "claim_origin": {
            "type": "string",
            "title": "Claim origin",
            "description": "Claim originator",
            "maxLength": 7,
            "enum": [
                "CLAIMER",
                "DONOR"
            ],
            "examples": [
                "CLAIMER"
            ]
        },
        "claim_status": {
            "type": "string",
            "title": "Claim status",
            "description": "Pix DICT key claim status",
            "maxLength": 20,
            "enum": [
                "OPEN",
                "WAITING_RESOLUTION",
                "WAITING_CLOSURE",
                "CONFIRMED",
                "CANCELLED",
                "COMPLETED"
            ],
            "example": [
                "OPEN"
            ]
        },
        "claim_type": {
            "type": "string",
            "title": "Claim type",
            "description": "Pix key claim type",
            "maxLength": 12,
            "enum": [
                "OWNERSHIP",
                "PORTABILITY"
            ],
            "examples": [
                "OWNERSHIP"
            ]
        },
        "key": {
            "type": "string",
            "title": "Pix key value",
            "description": "Pix key value of key type. For example: [email protected] (`EMAIL` key type)",
            "maxLength": 77,
            "examples": [
                "[email protected]",
                "12345678987"
            ]
        },
        "key_type": {
            "type": "string",
            "title": "Pix key type",
            "description": "Pix key type:<br> `CPF` - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US.<br> `CNPJ` - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil<br> `EMAIL` - Email<br> `PHONE` - Phone number<br> `EVP` - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.",
            "enum": [
                "CPF",
                "CNPJ",
                "PHONE",
                "EMAIL",
                "EVP"
            ],
            "examples": [
                "EMAIL"
            ]
        },
        "content_id": {
            "type": "string",
            "title": "Content identifier",
            "description": "Content ID. This is a hashed value created from a number of key-related fields in the Pismo database. This is meant for you to store and send to Pismo in case there is any problem with the key.",
            "maxLength": 64,
            "examples": [
                "a6506d3905962f9f00e118201a8710433406b3af87d2cc8c00a621f03a006ccd"
            ]
        },
        "cancel_reason": {
            "type": "string",
            "title": "Claim cancel reason",
            "description": "Claim cancellation reason. Will be null for non-cancelled claim",
            "maxLength": 20,
            "enum": [
                "USER_REQUESTED",
                "DEFAULT_OPERATION",
                "FRAUD",
                "ACCOUNT_CLOSURE",
                "RECONCILIATION"
            ],
            "examples": [
                "USER_REQUESTED"
            ]
        },
        "confirm_reason": {
            "type": "string",
            "title": "Claim confirmation reason",
            "description": "Claim confirmation reason. Will be null for non-confirmed claim",
            "maxLength": 20,
            "enum": [
                "USER_REQUESTED",
                "DEFAULT_OPERATION",
                "ACCOUNT_CLOSURE"
            ],
            "examples": [
                "USER_REQUESTED"
            ]
        },
        "resolution_period_end": {
            "type": "string",
            "title": "Resolution period end",
            "description": "Claim period end for the resolution. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-22T11:00:00.000Z"
            ]
        },
        "completion_period_end": {
            "type": "string",
            "title": "Completion period end",
            "description": "Claim period end to be completed. Might be null for claim type `PORTABILITY`. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        },
        "creation_datetime": {
            "type": "string",
            "title": "Creation Time",
            "description": "Claim creation datetime on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        },
        "last_modified": {
            "type": "string",
            "title": "Last modified",
            "description": "Last modification datetime on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        },
        "acknowledge_received_at": {
            "type": "string",
            "title": "Acknowledge received",
            "description": "Acknowledge received on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        }
    }
}

{
    "correlation_id": "51011dc9-5ecf-49c9-9fe4-1a7b13dfaf7",
    "account_id": 123456,
    "claim_id": "999f46ae-70be-4f9b-97a1-c0695903e962",
    "claim_origin": "CLAIMER",
    "claim_status": "OPEN",
    "claim_type": "OWNERSHIP",
    "key": "[email protected]",
    "key_type": "EMAIL",
    "content_id": "a6506d3905962f9f00e118201a8710433406b3af87d2cc8c00a621f03a006ccd",
    "cancel_reason": "USER_REQUESTED",
    "confirm_reason": "USER_REQUESTED",
    "resolution_period_end": "2021-10-22T11:00:00.000Z",
    "completion_period_end": "2021-10-29T11:00:00.000Z",
    "creation_datetime": "2021-10-29T11:00:00.000Z",
    "last_modified": "2021-10-29T11:00:00.000Z",
    "acknowledge_received_at": "2021-10-29T11:00:00.000Z"
}