Get a Wallet

GET

wallet

{id}

curl --request GET \
  --url https://api.plumaa.id/rest/v1/wallet/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "endorsables": {
    "items": [
      {
        "id": "<any>",
        "ownerId": "<string>",
        "timestamp": 123,
        "network": 123,
        "owner": {},
        "endorseEvents": {
          "items": [
            {
              "id": "<string>",
              "timestamp": 123,
              "fromId": "<string>",
              "toId": "<string>",
              "digest": "<any>",
              "network": 123,
              "from": {},
              "to": {},
              "token": {}
            }
          ],
          "pageInfo": {
            "hasNextPage": true,
            "hasPreviousPage": true,
            "startCursor": "<string>",
            "endCursor": "<string>"
          }
        },
        "witness": {
          "id": "<any>",
          "hash": "<any>",
          "algorithm": "SHA256",
          "initialOwner": {
            "id": "<any>",
            "commonName": "<string>",
            "serialNumber": "<string>",
            "country": "<any>",
            "RFC": "<string>",
            "emailAddress": "<any>",
            "certificate": {
              "id": "<any>",
              "serialNumber": "<any>",
              "issuer": {
                "id": "<any>",
                "RFC": "<string>",
                "hash": "<any>",
                "commonName": "<string>",
                "organization": "<string>",
                "organizationalUnitName": "<string>",
                "emailAddress": "<any>",
                "streetAddress": "<string>",
                "postalCode": 123,
                "country": "<any>",
                "stateOrProvinceName": "<string>",
                "localityName": "<string>",
                "publicKey": {
                  "exponent": "<any>",
                  "modulus": "<any>"
                },
                "certificatePem": "<string>",
                "createdAt": "<any>",
                "updatedAt": "<any>"
              },
              "notBefore": "<any>",
              "notAfter": "<any>",
              "subject": {},
              "publicKey": {
                "exponent": "<any>",
                "modulus": "<any>"
              },
              "version": "<any>",
              "hash": "<any>",
              "certificatePem": "<string>",
              "revoked": true,
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "termsInvite": {
              "id": "<any>",
              "signatureRequest": {
                "id": "<any>",
                "draft": true,
                "finalized": true,
                "name": "<string>",
                "content": {
                  "id": "<any>",
                  "raw": "<any>"
                },
                "anonymousKey": "<string>",
                "organization": {
                  "id": "<any>",
                  "name": "<string>",
                  "logo": "<any>",
                  "emailAddress": "<any>",
                  "quota": {
                    "id": "<any>",
                    "API": true,
                    "groupedNOM151": 123,
                    "nom151": 123
                  },
                  "policies": {
                    "signatureRequest": {
                      "conservation": "NOM151"
                    }
                  },
                  "createdAt": "<any>",
                  "updatedAt": "<any>"
                },
                "witness": {},
                "invites": [
                  {}
                ],
                "signed": "<any>",
                "pending": "<any>",
                "rejected": "<any>",
                "rejectedAt": "<any>",
                "createdAt": "<any>",
                "updatedAt": "<any>"
              },
              "subject": {},
              "certificate": {
                "id": "<any>",
                "serialNumber": "<any>",
                "issuer": {
                  "id": "<any>",
                  "RFC": "<string>",
                  "hash": "<any>",
                  "commonName": "<string>",
                  "organization": "<string>",
                  "organizationalUnitName": "<string>",
                  "emailAddress": "<any>",
                  "streetAddress": "<string>",
                  "postalCode": 123,
                  "country": "<any>",
                  "stateOrProvinceName": "<string>",
                  "localityName": "<string>",
                  "publicKey": {
                    "exponent": "<any>",
                    "modulus": "<any>"
                  },
                  "certificatePem": "<string>",
                  "createdAt": "<any>",
                  "updatedAt": "<any>"
                },
                "notBefore": "<any>",
                "notAfter": "<any>",
                "subject": {},
                "publicKey": {
                  "exponent": "<any>",
                  "modulus": "<any>"
                },
                "version": "<any>",
                "hash": "<any>",
                "certificatePem": "<string>",
                "revoked": true,
                "createdAt": "<any>",
                "updatedAt": "<any>"
              },
              "signature": "<any>",
              "ocspResponse": "<any>",
              "witness": {},
              "status": "PENDING",
              "rejectedAt": "<any>",
              "signedAt": "<any>",
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "pushNotificationToken": "<string>",
            "EVMAddress": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "wallet": {}
          },
          "claiming": {
            "id": "<any>",
            "authorizer": "<any>",
            "signature": "<any>",
            "claimer": "<any>",
            "network": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "claimed": true,
          "signatureRequest": {
            "id": "<any>",
            "draft": true,
            "finalized": true,
            "name": "<string>",
            "content": {
              "id": "<any>",
              "raw": "<any>"
            },
            "anonymousKey": "<string>",
            "organization": {
              "id": "<any>",
              "name": "<string>",
              "logo": "<any>",
              "emailAddress": "<any>",
              "quota": {
                "id": "<any>",
                "API": true,
                "groupedNOM151": 123,
                "nom151": 123
              },
              "policies": {
                "signatureRequest": {
                  "conservation": "NOM151"
                }
              },
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "witness": {},
            "invites": [
              {}
            ],
            "signed": "<any>",
            "pending": "<any>",
            "rejected": "<any>",
            "rejectedAt": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "organization": {
            "id": "<any>",
            "name": "<string>",
            "logo": "<any>",
            "emailAddress": "<any>",
            "quota": {
              "id": "<any>",
              "API": true,
              "groupedNOM151": 123,
              "nom151": 123
            },
            "policies": {
              "signatureRequest": {
                "conservation": "NOM151"
              }
            },
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "nom151": {
            "provider": "CINCEL",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "merkleized": {
            "txHash": "<any>",
            "network": "<any>",
            "merkleProof": [
              "<any>"
            ],
            "merkleRoot": "<any>",
            "nom151Provider": "CINCEL",
            "algorithm": "SHA256",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "witnessCo": {
            "timestamp": "<any>",
            "leafIndex": "<any>",
            "leftHashes": [
              "<any>"
            ],
            "rightHashes": [
              "<any>"
            ],
            "targetRootHash": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "timestampedAt": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "endorsable": {}
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "endorseFromEvents": {
    "items": [
      {
        "id": "<string>",
        "timestamp": 123,
        "fromId": "<string>",
        "toId": "<string>",
        "digest": "<any>",
        "network": 123,
        "from": {},
        "to": {},
        "token": {}
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "endorseToEvents": {
    "items": [
      {
        "id": "<string>",
        "timestamp": 123,
        "fromId": "<string>",
        "toId": "<string>",
        "digest": "<any>",
        "network": 123,
        "from": {},
        "to": {},
        "token": {}
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "subject": {
    "id": "<any>",
    "commonName": "<string>",
    "serialNumber": "<string>",
    "country": "<any>",
    "RFC": "<string>",
    "emailAddress": "<any>",
    "certificate": {
      "id": "<any>",
      "serialNumber": "<any>",
      "issuer": {
        "id": "<any>",
        "RFC": "<string>",
        "hash": "<any>",
        "commonName": "<string>",
        "organization": "<string>",
        "organizationalUnitName": "<string>",
        "emailAddress": "<any>",
        "streetAddress": "<string>",
        "postalCode": 123,
        "country": "<any>",
        "stateOrProvinceName": "<string>",
        "localityName": "<string>",
        "publicKey": {
          "exponent": "<any>",
          "modulus": "<any>"
        },
        "certificatePem": "<string>",
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "notBefore": "<any>",
      "notAfter": "<any>",
      "subject": {},
      "publicKey": {
        "exponent": "<any>",
        "modulus": "<any>"
      },
      "version": "<any>",
      "hash": "<any>",
      "certificatePem": "<string>",
      "revoked": true,
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "termsInvite": {
      "id": "<any>",
      "signatureRequest": {
        "id": "<any>",
        "draft": true,
        "finalized": true,
        "name": "<string>",
        "content": {
          "id": "<any>",
          "raw": "<any>"
        },
        "anonymousKey": "<string>",
        "organization": {
          "id": "<any>",
          "name": "<string>",
          "logo": "<any>",
          "emailAddress": "<any>",
          "quota": {
            "id": "<any>",
            "API": true,
            "groupedNOM151": 123,
            "nom151": 123
          },
          "policies": {
            "signatureRequest": {
              "conservation": "NOM151"
            }
          },
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "witness": {},
        "invites": [
          {}
        ],
        "signed": "<any>",
        "pending": "<any>",
        "rejected": "<any>",
        "rejectedAt": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "subject": {},
      "certificate": {
        "id": "<any>",
        "serialNumber": "<any>",
        "issuer": {
          "id": "<any>",
          "RFC": "<string>",
          "hash": "<any>",
          "commonName": "<string>",
          "organization": "<string>",
          "organizationalUnitName": "<string>",
          "emailAddress": "<any>",
          "streetAddress": "<string>",
          "postalCode": 123,
          "country": "<any>",
          "stateOrProvinceName": "<string>",
          "localityName": "<string>",
          "publicKey": {
            "exponent": "<any>",
            "modulus": "<any>"
          },
          "certificatePem": "<string>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "notBefore": "<any>",
        "notAfter": "<any>",
        "subject": {},
        "publicKey": {
          "exponent": "<any>",
          "modulus": "<any>"
        },
        "version": "<any>",
        "hash": "<any>",
        "certificatePem": "<string>",
        "revoked": true,
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "signature": "<any>",
      "ocspResponse": "<any>",
      "witness": {},
      "status": "PENDING",
      "rejectedAt": "<any>",
      "signedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "pushNotificationToken": "<string>",
    "EVMAddress": "<any>",
    "createdAt": "<any>",
    "updatedAt": "<any>",
    "wallet": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Query Parameters

wallet_endorsables_where

object

wallet_endorsables_where.AND

object[]

wallet_endorsables_where.OR

object[]

wallet_endorsables_where.id

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_not

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_not_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_gt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_lt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_gte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.id_lte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_where.ownerId

string

wallet_endorsables_where.ownerId_not

string

wallet_endorsables_where.ownerId_in

string[]

wallet_endorsables_where.ownerId_not_in

string[]

wallet_endorsables_where.ownerId_gt

string

wallet_endorsables_where.ownerId_lt

string

wallet_endorsables_where.ownerId_gte

string

wallet_endorsables_where.ownerId_lte

string

wallet_endorsables_where.timestamp

integer

wallet_endorsables_where.timestamp_not

integer

wallet_endorsables_where.timestamp_in

integer[]

wallet_endorsables_where.timestamp_not_in

integer[]

wallet_endorsables_where.timestamp_gt

integer

wallet_endorsables_where.timestamp_lt

integer

wallet_endorsables_where.timestamp_gte

integer

wallet_endorsables_where.timestamp_lte

integer

wallet_endorsables_where.network

integer

wallet_endorsables_where.network_not

integer

wallet_endorsables_where.network_in

integer[]

wallet_endorsables_where.network_not_in

integer[]

wallet_endorsables_where.network_gt

integer

wallet_endorsables_where.network_lt

integer

wallet_endorsables_where.network_gte

integer

wallet_endorsables_where.network_lte

integer

wallet_endorsables_orderBy

string

wallet_endorsables_orderDirection

string

wallet_endorsables_before

string

wallet_endorsables_after

string

wallet_endorsables_limit

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where

object

wallet_endorsables_endorsables_items_items_endorseEvents_where.AND

object[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.OR

object[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.id

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_not

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_in

string[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_not_in

string[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_contains

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_not_contains

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_starts_with

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_ends_with

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_not_starts_with

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.id_not_ends_with

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_not

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_in

integer[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_not_in

integer[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_gt

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_lt

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_gte

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.timestamp_lte

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_not

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_in

string[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_not_in

string[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_gt

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_lt

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_gte

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.fromId_lte

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_not

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_in

string[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_not_in

string[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_gt

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_lt

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_gte

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.toId_lte

string

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_not

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_not_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_gt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_lt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_gte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.digest_lte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorsables_endorsables_items_items_endorseEvents_where.network

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_not

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_in

integer[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_not_in

integer[]

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_gt

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_lt

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_gte

integer

wallet_endorsables_endorsables_items_items_endorseEvents_where.network_lte

integer

wallet_endorsables_endorsables_items_items_endorseEvents_orderBy

string

wallet_endorsables_endorsables_items_items_endorseEvents_orderDirection

string

wallet_endorsables_endorsables_items_items_endorseEvents_before

string

wallet_endorsables_endorsables_items_items_endorseEvents_after

string

wallet_endorsables_endorsables_items_items_endorseEvents_limit

integer

wallet_endorseFromEvents_where

object

wallet_endorseFromEvents_where.AND

object[]

wallet_endorseFromEvents_where.OR

object[]

wallet_endorseFromEvents_where.id

string

wallet_endorseFromEvents_where.id_not

string

wallet_endorseFromEvents_where.id_in

string[]

wallet_endorseFromEvents_where.id_not_in

string[]

wallet_endorseFromEvents_where.id_contains

string

wallet_endorseFromEvents_where.id_not_contains

string

wallet_endorseFromEvents_where.id_starts_with

string

wallet_endorseFromEvents_where.id_ends_with

string

wallet_endorseFromEvents_where.id_not_starts_with

string

wallet_endorseFromEvents_where.id_not_ends_with

string

wallet_endorseFromEvents_where.timestamp

integer

wallet_endorseFromEvents_where.timestamp_not

integer

wallet_endorseFromEvents_where.timestamp_in

integer[]

wallet_endorseFromEvents_where.timestamp_not_in

integer[]

wallet_endorseFromEvents_where.timestamp_gt

integer

wallet_endorseFromEvents_where.timestamp_lt

integer

wallet_endorseFromEvents_where.timestamp_gte

integer

wallet_endorseFromEvents_where.timestamp_lte

integer

wallet_endorseFromEvents_where.fromId

string

wallet_endorseFromEvents_where.fromId_not

string

wallet_endorseFromEvents_where.fromId_in

string[]

wallet_endorseFromEvents_where.fromId_not_in

string[]

wallet_endorseFromEvents_where.fromId_gt

string

wallet_endorseFromEvents_where.fromId_lt

string

wallet_endorseFromEvents_where.fromId_gte

string

wallet_endorseFromEvents_where.fromId_lte

string

wallet_endorseFromEvents_where.toId

string

wallet_endorseFromEvents_where.toId_not

string

wallet_endorseFromEvents_where.toId_in

string[]

wallet_endorseFromEvents_where.toId_not_in

string[]

wallet_endorseFromEvents_where.toId_gt

string

wallet_endorseFromEvents_where.toId_lt

string

wallet_endorseFromEvents_where.toId_gte

string

wallet_endorseFromEvents_where.toId_lte

string

wallet_endorseFromEvents_where.digest

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_not

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_not_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_gt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_lt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_gte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.digest_lte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseFromEvents_where.network

integer

wallet_endorseFromEvents_where.network_not

integer

wallet_endorseFromEvents_where.network_in

integer[]

wallet_endorseFromEvents_where.network_not_in

integer[]

wallet_endorseFromEvents_where.network_gt

integer

wallet_endorseFromEvents_where.network_lt

integer

wallet_endorseFromEvents_where.network_gte

integer

wallet_endorseFromEvents_where.network_lte

integer

wallet_endorseFromEvents_orderBy

string

wallet_endorseFromEvents_orderDirection

string

wallet_endorseFromEvents_before

string

wallet_endorseFromEvents_after

string

wallet_endorseFromEvents_limit

integer

wallet_endorseToEvents_where

object

wallet_endorseToEvents_where.AND

object[]

wallet_endorseToEvents_where.OR

object[]

wallet_endorseToEvents_where.id

string

wallet_endorseToEvents_where.id_not

string

wallet_endorseToEvents_where.id_in

string[]

wallet_endorseToEvents_where.id_not_in

string[]

wallet_endorseToEvents_where.id_contains

string

wallet_endorseToEvents_where.id_not_contains

string

wallet_endorseToEvents_where.id_starts_with

string

wallet_endorseToEvents_where.id_ends_with

string

wallet_endorseToEvents_where.id_not_starts_with

string

wallet_endorseToEvents_where.id_not_ends_with

string

wallet_endorseToEvents_where.timestamp

integer

wallet_endorseToEvents_where.timestamp_not

integer

wallet_endorseToEvents_where.timestamp_in

integer[]

wallet_endorseToEvents_where.timestamp_not_in

integer[]

wallet_endorseToEvents_where.timestamp_gt

integer

wallet_endorseToEvents_where.timestamp_lt

integer

wallet_endorseToEvents_where.timestamp_gte

integer

wallet_endorseToEvents_where.timestamp_lte

integer

wallet_endorseToEvents_where.fromId

string

wallet_endorseToEvents_where.fromId_not

string

wallet_endorseToEvents_where.fromId_in

string[]

wallet_endorseToEvents_where.fromId_not_in

string[]

wallet_endorseToEvents_where.fromId_gt

string

wallet_endorseToEvents_where.fromId_lt

string

wallet_endorseToEvents_where.fromId_gte

string

wallet_endorseToEvents_where.fromId_lte

string

wallet_endorseToEvents_where.toId

string

wallet_endorseToEvents_where.toId_not

string

wallet_endorseToEvents_where.toId_in

string[]

wallet_endorseToEvents_where.toId_not_in

string[]

wallet_endorseToEvents_where.toId_gt

string

wallet_endorseToEvents_where.toId_lt

string

wallet_endorseToEvents_where.toId_gte

string

wallet_endorseToEvents_where.toId_lte

string

wallet_endorseToEvents_where.digest

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_not

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_not_in

any[]

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_gt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_lt

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_gte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.digest_lte

any

The BigInt scalar type represents non-fractional signed whole numeric values.

wallet_endorseToEvents_where.network

integer

wallet_endorseToEvents_where.network_not

integer

wallet_endorseToEvents_where.network_in

integer[]

wallet_endorseToEvents_where.network_not_in

integer[]

wallet_endorseToEvents_where.network_gt

integer

wallet_endorseToEvents_where.network_lt

integer

wallet_endorseToEvents_where.network_gte

integer

wallet_endorseToEvents_where.network_lte

integer

wallet_endorseToEvents_orderBy

string

wallet_endorseToEvents_orderDirection

string

wallet_endorseToEvents_before

string

wallet_endorseToEvents_after

string

wallet_endorseToEvents_limit

integer

Response

200 - application/json

string

required

endorsables

object

endorsables.items

object[]

required

endorsables.items.id

any

required

The BigInt scalar type represents non-fractional signed whole numeric values.

endorsables.items.ownerId

string

required

endorsables.items.timestamp

integer

required

endorsables.items.network

integer

required

endorsables.items.owner

object

required

endorsables.items.owner.id

string

required

endorsables.items.owner.endorsables

object

endorsables.items.owner.endorseFromEvents

object

endorsables.items.owner.endorseToEvents

object

endorsables.items.owner.subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

endorsables.items.owner.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorsables.items.owner.subject.commonName

string

required

Name of the subject.

endorsables.items.owner.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

endorsables.items.owner.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

endorsables.items.owner.subject.EVMAddress

any

required

EVM address of the subject.

Each account is a smart account that includes a single signer contract deterministically created from a factory deployed through xdeployer so that every signer contract has the same address in all EVM networks. This signer contract is an implementation of a custom ERC-1271 interface that allows the RSA key to sign on-chain. Signers can be deployed trustlessly by anyone since they're controlled by the account owner.

The smart account is created from the Safe{Wallet} factory and includes a setup call to the RSA signer factory, deploying the signer contract who'll own the account. The account factory is already deployed on all networks with the same address so that the account can be created deterministically in all EVM networks too

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

endorsables.items.owner.subject.createdAt

any

required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

endorsables.items.owner.subject.updatedAt

any

required

endorsables.items.owner.subject.country

any

Country of the subject.

endorsables.items.owner.subject.emailAddress

any

Email address of the subject.

endorsables.items.owner.subject.certificate

object

Certificate of the subject.

endorsables.items.owner.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

endorsables.items.owner.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

endorsables.items.owner.subject.wallet

object

endorsables.items.endorseEvents

object

endorsables.items.witness

object

A witness is an entity representing a proof that a document existed at the time. It is used to comply with the law requirement of data conservation.

endorsables.items.witness.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorsables.items.witness.hash

any

required

Hash of the document to witness.

endorsables.items.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

endorsables.items.witness.organization

object

required

Organization that created the witness.

endorsables.items.witness.createdAt

any

required

endorsables.items.witness.updatedAt

any

required

endorsables.items.witness.initialOwner

object

Subject designed as the first in the endorsement chain. Only a member of the operating organization can set this field. Once set, our on-chain relayer will submit a proof of endorsement to the Witness contract so that the corresponding token can be minted by the user later on the application.

endorsables.items.witness.initialOwner.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorsables.items.witness.initialOwner.commonName

string

required

Name of the subject.

endorsables.items.witness.initialOwner.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

endorsables.items.witness.initialOwner.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

endorsables.items.witness.initialOwner.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

endorsables.items.witness.initialOwner.createdAt

any

required

endorsables.items.witness.initialOwner.updatedAt

any

required

endorsables.items.witness.initialOwner.country

any

Country of the subject.

endorsables.items.witness.initialOwner.emailAddress

any

Email address of the subject.

endorsables.items.witness.initialOwner.certificate

object

Certificate of the subject.

endorsables.items.witness.initialOwner.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

endorsables.items.witness.initialOwner.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

endorsables.items.witness.initialOwner.wallet

object

endorsables.items.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

endorsables.items.witness.claimed

boolean

If the witness has been claimed by the initial owner.

endorsables.items.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

endorsables.items.witness.signatureRequest.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorsables.items.witness.signatureRequest.draft

boolean

required

Whether the document is a draft or not. A draft signature request won't allow invites to sign and will skip processing notifications.

endorsables.items.witness.signatureRequest.finalized

boolean

required

Whether the document is finalized or not. A finalized request won't allow new invites and won't process any new notifications.

endorsables.items.witness.signatureRequest.name

string

required

Custom name for the signature request.

endorsables.items.witness.signatureRequest.content

object

required

The content data to be signed.

endorsables.items.witness.signatureRequest.anonymousKey

string

required

Key for sharing the sharing the signature request. Can be used to access the signature request without authentication.

endorsables.items.witness.signatureRequest.organization

object

required

The organization requesting the signature.

endorsables.items.witness.signatureRequest.witness

object

required

Witness that attest the content using a merkle proof

endorsables.items.witness.signatureRequest.invites

object[]

required

Invites to sign the content.

A signature request invite is an invite to sign a signature request. It links a signature request to a subject and it stores its corresponding signature and the link to the certificate that the signature belongs to.

endorsables.items.witness.signatureRequest.signed

any

required

Amount of invites that have signed the content.

endorsables.items.witness.signatureRequest.pending

any

required

Amount of invites that have not signed the content.

endorsables.items.witness.signatureRequest.rejected

any

required

Amount of invites that have rejected the content.

endorsables.items.witness.signatureRequest.createdAt

any

required

endorsables.items.witness.signatureRequest.updatedAt

any

required

endorsables.items.witness.signatureRequest.rejectedAt

any

Date when the signature request was rejected. Only present if rejected.

endorsables.items.witness.nom151

object

Individual NOM151 conservation strategy.

endorsables.items.witness.merkleized

object

Combined merkleized conservation strategy.

endorsables.items.witness.witnessCo

object

Witness conservation strategy.

endorsables.items.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

endorsables.items.witness.endorsable

object

endorsables.pageInfo

object

required

endorseFromEvents

object

endorseFromEvents.items

object[]

required

endorseFromEvents.items.id

string

required

endorseFromEvents.items.timestamp

integer

required

endorseFromEvents.items.fromId

string

required

endorseFromEvents.items.toId

string

required

endorseFromEvents.items.digest

any

required

The BigInt scalar type represents non-fractional signed whole numeric values.

endorseFromEvents.items.network

integer

required

endorseFromEvents.items.from

object

required

endorseFromEvents.items.from.id

string

required

endorseFromEvents.items.from.endorsables

object

endorseFromEvents.items.from.endorseFromEvents

object

endorseFromEvents.items.from.endorseToEvents

object

endorseFromEvents.items.from.subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

endorseFromEvents.items.from.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorseFromEvents.items.from.subject.commonName

string

required

Name of the subject.

endorseFromEvents.items.from.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

endorseFromEvents.items.from.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

endorseFromEvents.items.from.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

endorseFromEvents.items.from.subject.createdAt

any

required

endorseFromEvents.items.from.subject.updatedAt

any

required

endorseFromEvents.items.from.subject.country

any

Country of the subject.

endorseFromEvents.items.from.subject.emailAddress

any

Email address of the subject.

endorseFromEvents.items.from.subject.certificate

object

Certificate of the subject.

endorseFromEvents.items.from.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

endorseFromEvents.items.from.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

endorseFromEvents.items.from.subject.wallet

object

endorseFromEvents.items.to

object

required

endorseFromEvents.items.to.id

string

required

endorseFromEvents.items.to.endorsables

object

endorseFromEvents.items.to.endorseFromEvents

object

endorseFromEvents.items.to.endorseToEvents

object

endorseFromEvents.items.to.subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

endorseFromEvents.items.to.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorseFromEvents.items.to.subject.commonName

string

required

Name of the subject.

endorseFromEvents.items.to.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

endorseFromEvents.items.to.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

endorseFromEvents.items.to.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

endorseFromEvents.items.to.subject.createdAt

any

required

endorseFromEvents.items.to.subject.updatedAt

any

required

endorseFromEvents.items.to.subject.country

any

Country of the subject.

endorseFromEvents.items.to.subject.emailAddress

any

Email address of the subject.

endorseFromEvents.items.to.subject.certificate

object

Certificate of the subject.

endorseFromEvents.items.to.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

endorseFromEvents.items.to.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

endorseFromEvents.items.to.subject.wallet

object

endorseFromEvents.items.token

object

required

endorseFromEvents.items.token.id

any

required

The BigInt scalar type represents non-fractional signed whole numeric values.

endorseFromEvents.items.token.ownerId

string

required

endorseFromEvents.items.token.timestamp

integer

required

endorseFromEvents.items.token.network

integer

required

endorseFromEvents.items.token.owner

object

required

endorseFromEvents.items.token.endorseEvents

object

endorseFromEvents.items.token.witness

object

A witness is an entity representing a proof that a document existed at the time. It is used to comply with the law requirement of data conservation.

endorseFromEvents.items.token.witness.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorseFromEvents.items.token.witness.hash

any

required

Hash of the document to witness.

endorseFromEvents.items.token.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

endorseFromEvents.items.token.witness.organization

object

required

Organization that created the witness.

endorseFromEvents.items.token.witness.createdAt

any

required

endorseFromEvents.items.token.witness.updatedAt

any

required

endorseFromEvents.items.token.witness.initialOwner

object

endorseFromEvents.items.token.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

endorseFromEvents.items.token.witness.claimed

boolean

If the witness has been claimed by the initial owner.

endorseFromEvents.items.token.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

endorseFromEvents.items.token.witness.nom151

object

Individual NOM151 conservation strategy.

endorseFromEvents.items.token.witness.merkleized

object

Combined merkleized conservation strategy.

endorseFromEvents.items.token.witness.witnessCo

object

Witness conservation strategy.

endorseFromEvents.items.token.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

endorseFromEvents.items.token.witness.endorsable

object

endorseFromEvents.pageInfo

object

required

endorseToEvents

object

endorseToEvents.items

object[]

required

endorseToEvents.items.id

string

required

endorseToEvents.items.timestamp

integer

required

endorseToEvents.items.fromId

string

required

endorseToEvents.items.toId

string

required

endorseToEvents.items.digest

any

required

The BigInt scalar type represents non-fractional signed whole numeric values.

endorseToEvents.items.network

integer

required

endorseToEvents.items.from

object

required

endorseToEvents.items.from.id

string

required

endorseToEvents.items.from.endorsables

object

endorseToEvents.items.from.endorseFromEvents

object

endorseToEvents.items.from.endorseToEvents

object

endorseToEvents.items.from.subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

endorseToEvents.items.from.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorseToEvents.items.from.subject.commonName

string

required

Name of the subject.

endorseToEvents.items.from.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

endorseToEvents.items.from.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

endorseToEvents.items.from.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

endorseToEvents.items.from.subject.createdAt

any

required

endorseToEvents.items.from.subject.updatedAt

any

required

endorseToEvents.items.from.subject.country

any

Country of the subject.

endorseToEvents.items.from.subject.emailAddress

any

Email address of the subject.

endorseToEvents.items.from.subject.certificate

object

Certificate of the subject.

endorseToEvents.items.from.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

endorseToEvents.items.from.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

endorseToEvents.items.from.subject.wallet

object

endorseToEvents.items.to

object

required

endorseToEvents.items.to.id

string

required

endorseToEvents.items.to.endorsables

object

endorseToEvents.items.to.endorseFromEvents

object

endorseToEvents.items.to.endorseToEvents

object

endorseToEvents.items.to.subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

endorseToEvents.items.to.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorseToEvents.items.to.subject.commonName

string

required

Name of the subject.

endorseToEvents.items.to.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

endorseToEvents.items.to.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

endorseToEvents.items.to.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

endorseToEvents.items.to.subject.createdAt

any

required

endorseToEvents.items.to.subject.updatedAt

any

required

endorseToEvents.items.to.subject.country

any

Country of the subject.

endorseToEvents.items.to.subject.emailAddress

any

Email address of the subject.

endorseToEvents.items.to.subject.certificate

object

Certificate of the subject.

endorseToEvents.items.to.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

endorseToEvents.items.to.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

endorseToEvents.items.to.subject.wallet

object

endorseToEvents.items.token

object

required

endorseToEvents.items.token.id

any

required

The BigInt scalar type represents non-fractional signed whole numeric values.

endorseToEvents.items.token.ownerId

string

required

endorseToEvents.items.token.timestamp

integer

required

endorseToEvents.items.token.network

integer

required

endorseToEvents.items.token.owner

object

required

endorseToEvents.items.token.endorseEvents

object

endorseToEvents.items.token.witness

object

A witness is an entity representing a proof that a document existed at the time. It is used to comply with the law requirement of data conservation.

endorseToEvents.items.token.witness.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

endorseToEvents.items.token.witness.hash

any

required

Hash of the document to witness.

endorseToEvents.items.token.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

endorseToEvents.items.token.witness.organization

object

required

Organization that created the witness.

endorseToEvents.items.token.witness.createdAt

any

required

endorseToEvents.items.token.witness.updatedAt

any

required

endorseToEvents.items.token.witness.initialOwner

object

endorseToEvents.items.token.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

endorseToEvents.items.token.witness.claimed

boolean

If the witness has been claimed by the initial owner.

endorseToEvents.items.token.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

endorseToEvents.items.token.witness.nom151

object

Individual NOM151 conservation strategy.

endorseToEvents.items.token.witness.merkleized

object

Combined merkleized conservation strategy.

endorseToEvents.items.token.witness.witnessCo

object

Witness conservation strategy.

endorseToEvents.items.token.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

endorseToEvents.items.token.witness.endorsable

object

endorseToEvents.pageInfo

object

required

subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.commonName

string

required

Name of the subject.

subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

subject.createdAt

any

required

subject.updatedAt

any

required

subject.country

any

Country of the subject.

subject.emailAddress

any

Email address of the subject.

subject.certificate

object

Certificate of the subject.

subject.certificate.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

subject.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

subject.certificate.issuer.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.certificate.issuer.hash

any

required

The hash of the issuer's certificate.

subject.certificate.issuer.commonName

string

required

The name of the certificate authority.

subject.certificate.issuer.publicKey

object

required

The issuer's certificate public key. This is the public key that identifies messages the issuer has signed a certificate for a subject.

subject.certificate.issuer.certificatePem

string

required

AWS S3 URI path to the issuer certificate's PEM data.

subject.certificate.issuer.createdAt

any

required

subject.certificate.issuer.updatedAt

any

required

subject.certificate.issuer.RFC

string

RFC of the issuer.

subject.certificate.issuer.organization

string

Name of the organization or company. "Razón Social" in Spanish.

subject.certificate.issuer.organizationalUnitName

string

Name of the unit within the organization. "Unidad Organizacional" in Spanish.

subject.certificate.issuer.emailAddress

any

Email address of the issuer.

subject.certificate.issuer.streetAddress

string

Street address of the issuer.

subject.certificate.issuer.postalCode

integer

Postal code of the issuer.

subject.certificate.issuer.country

any

"Country" of the issuer.

subject.certificate.issuer.stateOrProvinceName

string

"Entidad Federativa" of the issuer.

subject.certificate.issuer.localityName

string

"Municipio/Delegación" of the issuer.

subject.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

subject.certificate.notAfter

any

required

The latest date at which the certificate is valid.

subject.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

subject.certificate.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.certificate.subject.commonName

string

required

Name of the subject.

subject.certificate.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

subject.certificate.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

subject.certificate.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

subject.certificate.subject.createdAt

any

required

subject.certificate.subject.updatedAt

any

required

subject.certificate.subject.country

any

Country of the subject.

subject.certificate.subject.emailAddress

any

Email address of the subject.

subject.certificate.subject.certificate

object

Certificate of the subject.

subject.certificate.subject.certificate.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.certificate.subject.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

subject.certificate.subject.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

subject.certificate.subject.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

subject.certificate.subject.certificate.notAfter

any

required

The latest date at which the certificate is valid.

subject.certificate.subject.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

subject.certificate.subject.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

subject.certificate.subject.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

subject.certificate.subject.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

subject.certificate.subject.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

subject.certificate.subject.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

subject.certificate.subject.certificate.createdAt

any

required

subject.certificate.subject.certificate.updatedAt

any

required

subject.certificate.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

subject.certificate.subject.termsInvite.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.certificate.subject.termsInvite.signatureRequest

object

required

The signature request this invite is linked to.

subject.certificate.subject.termsInvite.subject

object

required

The subject this invite is linked to.

subject.certificate.subject.termsInvite.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

subject.certificate.subject.termsInvite.createdAt

any

required

subject.certificate.subject.termsInvite.updatedAt

any

required

subject.certificate.subject.termsInvite.certificate

object

The certificate this invite was signed with.

subject.certificate.subject.termsInvite.signature

any

The signature from the certificate as a hexadecimal string.

subject.certificate.subject.termsInvite.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

subject.certificate.subject.termsInvite.witness

object

Witness that attest the signature using a merkle proof

subject.certificate.subject.termsInvite.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

subject.certificate.subject.termsInvite.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

subject.certificate.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

subject.certificate.subject.wallet

object

subject.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

subject.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

subject.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

subject.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

subject.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

subject.certificate.createdAt

any

required

subject.certificate.updatedAt

any

required

subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

subject.termsInvite.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.signatureRequest

object

required

The signature request this invite is linked to.

subject.termsInvite.signatureRequest.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.signatureRequest.draft

boolean

required

Whether the document is a draft or not. A draft signature request won't allow invites to sign and will skip processing notifications.

subject.termsInvite.signatureRequest.finalized

boolean

required

Whether the document is finalized or not. A finalized request won't allow new invites and won't process any new notifications.

subject.termsInvite.signatureRequest.name

string

required

Custom name for the signature request.

subject.termsInvite.signatureRequest.content

object

required

The content data to be signed.

subject.termsInvite.signatureRequest.anonymousKey

string

required

Key for sharing the sharing the signature request. Can be used to access the signature request without authentication.

subject.termsInvite.signatureRequest.organization

object

required

The organization requesting the signature.

subject.termsInvite.signatureRequest.witness

object

required

Witness that attest the content using a merkle proof

subject.termsInvite.signatureRequest.witness.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.signatureRequest.witness.hash

any

required

Hash of the document to witness.

subject.termsInvite.signatureRequest.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

subject.termsInvite.signatureRequest.witness.organization

object

required

Organization that created the witness.

subject.termsInvite.signatureRequest.witness.createdAt

any

required

subject.termsInvite.signatureRequest.witness.updatedAt

any

required

subject.termsInvite.signatureRequest.witness.initialOwner

object

subject.termsInvite.signatureRequest.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

subject.termsInvite.signatureRequest.witness.claimed

boolean

If the witness has been claimed by the initial owner.

subject.termsInvite.signatureRequest.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

subject.termsInvite.signatureRequest.witness.nom151

object

Individual NOM151 conservation strategy.

subject.termsInvite.signatureRequest.witness.merkleized

object

Combined merkleized conservation strategy.

subject.termsInvite.signatureRequest.witness.witnessCo

object

Witness conservation strategy.

subject.termsInvite.signatureRequest.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

subject.termsInvite.signatureRequest.witness.endorsable

object

subject.termsInvite.signatureRequest.invites

object[]

required

Invites to sign the content.

subject.termsInvite.signatureRequest.invites.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.signatureRequest.invites.signatureRequest

object

required

The signature request this invite is linked to.

subject.termsInvite.signatureRequest.invites.subject

object

required

The subject this invite is linked to.

subject.termsInvite.signatureRequest.invites.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

subject.termsInvite.signatureRequest.invites.createdAt

any

required

subject.termsInvite.signatureRequest.invites.updatedAt

any

required

subject.termsInvite.signatureRequest.invites.certificate

object

The certificate this invite was signed with.

subject.termsInvite.signatureRequest.invites.signature

any

The signature from the certificate as a hexadecimal string.

subject.termsInvite.signatureRequest.invites.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

subject.termsInvite.signatureRequest.invites.witness

object

Witness that attest the signature using a merkle proof

subject.termsInvite.signatureRequest.invites.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

subject.termsInvite.signatureRequest.invites.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

subject.termsInvite.signatureRequest.signed

any

required

Amount of invites that have signed the content.

subject.termsInvite.signatureRequest.pending

any

required

Amount of invites that have not signed the content.

subject.termsInvite.signatureRequest.rejected

any

required

Amount of invites that have rejected the content.

subject.termsInvite.signatureRequest.createdAt

any

required

subject.termsInvite.signatureRequest.updatedAt

any

required

subject.termsInvite.signatureRequest.rejectedAt

any

Date when the signature request was rejected. Only present if rejected.

subject.termsInvite.subject

object

required

The subject this invite is linked to.

subject.termsInvite.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.subject.commonName

string

required

Name of the subject.

subject.termsInvite.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

subject.termsInvite.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

subject.termsInvite.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

subject.termsInvite.subject.createdAt

any

required

subject.termsInvite.subject.updatedAt

any

required

subject.termsInvite.subject.country

any

Country of the subject.

subject.termsInvite.subject.emailAddress

any

Email address of the subject.

subject.termsInvite.subject.certificate

object

Certificate of the subject.

subject.termsInvite.subject.certificate.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.subject.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

subject.termsInvite.subject.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

subject.termsInvite.subject.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

subject.termsInvite.subject.certificate.notAfter

any

required

The latest date at which the certificate is valid.

subject.termsInvite.subject.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

subject.termsInvite.subject.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

subject.termsInvite.subject.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

subject.termsInvite.subject.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

subject.termsInvite.subject.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

subject.termsInvite.subject.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

subject.termsInvite.subject.certificate.createdAt

any

required

subject.termsInvite.subject.certificate.updatedAt

any

required

subject.termsInvite.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

subject.termsInvite.subject.termsInvite.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.subject.termsInvite.signatureRequest

object

required

The signature request this invite is linked to.

subject.termsInvite.subject.termsInvite.subject

object

required

The subject this invite is linked to.

subject.termsInvite.subject.termsInvite.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

subject.termsInvite.subject.termsInvite.createdAt

any

required

subject.termsInvite.subject.termsInvite.updatedAt

any

required

subject.termsInvite.subject.termsInvite.certificate

object

The certificate this invite was signed with.

subject.termsInvite.subject.termsInvite.signature

any

The signature from the certificate as a hexadecimal string.

subject.termsInvite.subject.termsInvite.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

subject.termsInvite.subject.termsInvite.witness

object

Witness that attest the signature using a merkle proof

subject.termsInvite.subject.termsInvite.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

subject.termsInvite.subject.termsInvite.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

subject.termsInvite.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

subject.termsInvite.subject.wallet

object

subject.termsInvite.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

subject.termsInvite.createdAt

any

required

subject.termsInvite.updatedAt

any

required

subject.termsInvite.certificate

object

The certificate this invite was signed with.

subject.termsInvite.certificate.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

subject.termsInvite.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

subject.termsInvite.certificate.issuer.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.certificate.issuer.hash

any

required

The hash of the issuer's certificate.

subject.termsInvite.certificate.issuer.commonName

string

required

The name of the certificate authority.

subject.termsInvite.certificate.issuer.publicKey

object

required

The issuer's certificate public key. This is the public key that identifies messages the issuer has signed a certificate for a subject.

subject.termsInvite.certificate.issuer.certificatePem

string

required

AWS S3 URI path to the issuer certificate's PEM data.

subject.termsInvite.certificate.issuer.createdAt

any

required

subject.termsInvite.certificate.issuer.updatedAt

any

required

subject.termsInvite.certificate.issuer.RFC

string

RFC of the issuer.

subject.termsInvite.certificate.issuer.organization

string

Name of the organization or company. "Razón Social" in Spanish.

subject.termsInvite.certificate.issuer.organizationalUnitName

string

Name of the unit within the organization. "Unidad Organizacional" in Spanish.

subject.termsInvite.certificate.issuer.emailAddress

any

Email address of the issuer.

subject.termsInvite.certificate.issuer.streetAddress

string

Street address of the issuer.

subject.termsInvite.certificate.issuer.postalCode

integer

Postal code of the issuer.

subject.termsInvite.certificate.issuer.country

any

"Country" of the issuer.

subject.termsInvite.certificate.issuer.stateOrProvinceName

string

"Entidad Federativa" of the issuer.

subject.termsInvite.certificate.issuer.localityName

string

"Municipio/Delegación" of the issuer.

subject.termsInvite.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

subject.termsInvite.certificate.notAfter

any

required

The latest date at which the certificate is valid.

subject.termsInvite.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

subject.termsInvite.certificate.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.certificate.subject.commonName

string

required

Name of the subject.

subject.termsInvite.certificate.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

subject.termsInvite.certificate.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

subject.termsInvite.certificate.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

subject.termsInvite.certificate.subject.createdAt

any

required

subject.termsInvite.certificate.subject.updatedAt

any

required

subject.termsInvite.certificate.subject.country

any

Country of the subject.

subject.termsInvite.certificate.subject.emailAddress

any

Email address of the subject.

subject.termsInvite.certificate.subject.certificate

object

Certificate of the subject.

subject.termsInvite.certificate.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

subject.termsInvite.certificate.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

subject.termsInvite.certificate.subject.wallet

object

subject.termsInvite.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

subject.termsInvite.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

subject.termsInvite.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

subject.termsInvite.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

subject.termsInvite.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

subject.termsInvite.certificate.createdAt

any

required

subject.termsInvite.certificate.updatedAt

any

required

subject.termsInvite.signature

any

The signature from the certificate as a hexadecimal string.

subject.termsInvite.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

subject.termsInvite.witness

object

Witness that attest the signature using a merkle proof

subject.termsInvite.witness.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.witness.hash

any

required

Hash of the document to witness.

subject.termsInvite.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

subject.termsInvite.witness.organization

object

required

Organization that created the witness.

subject.termsInvite.witness.createdAt

any

required

subject.termsInvite.witness.updatedAt

any

required

subject.termsInvite.witness.initialOwner

object

subject.termsInvite.witness.initialOwner.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.witness.initialOwner.commonName

string

required

Name of the subject.

subject.termsInvite.witness.initialOwner.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

subject.termsInvite.witness.initialOwner.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

subject.termsInvite.witness.initialOwner.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

subject.termsInvite.witness.initialOwner.createdAt

any

required

subject.termsInvite.witness.initialOwner.updatedAt

any

required

subject.termsInvite.witness.initialOwner.country

any

Country of the subject.

subject.termsInvite.witness.initialOwner.emailAddress

any

Email address of the subject.

subject.termsInvite.witness.initialOwner.certificate

object

Certificate of the subject.

subject.termsInvite.witness.initialOwner.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

subject.termsInvite.witness.initialOwner.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

subject.termsInvite.witness.initialOwner.wallet

object

subject.termsInvite.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

subject.termsInvite.witness.claimed

boolean

If the witness has been claimed by the initial owner.

subject.termsInvite.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

subject.termsInvite.witness.signatureRequest.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.termsInvite.witness.signatureRequest.draft

boolean

required

Whether the document is a draft or not. A draft signature request won't allow invites to sign and will skip processing notifications.

subject.termsInvite.witness.signatureRequest.finalized

boolean

required

Whether the document is finalized or not. A finalized request won't allow new invites and won't process any new notifications.

subject.termsInvite.witness.signatureRequest.name

string

required

Custom name for the signature request.

subject.termsInvite.witness.signatureRequest.content

object

required

The content data to be signed.

subject.termsInvite.witness.signatureRequest.anonymousKey

string

required

Key for sharing the sharing the signature request. Can be used to access the signature request without authentication.

subject.termsInvite.witness.signatureRequest.organization

object

required

The organization requesting the signature.

subject.termsInvite.witness.signatureRequest.witness

object

required

Witness that attest the content using a merkle proof

subject.termsInvite.witness.signatureRequest.invites

object[]

required

Invites to sign the content.

subject.termsInvite.witness.signatureRequest.signed

any

required

Amount of invites that have signed the content.

subject.termsInvite.witness.signatureRequest.pending

any

required

Amount of invites that have not signed the content.

subject.termsInvite.witness.signatureRequest.rejected

any

required

Amount of invites that have rejected the content.

subject.termsInvite.witness.signatureRequest.createdAt

any

required

subject.termsInvite.witness.signatureRequest.updatedAt

any

required

subject.termsInvite.witness.signatureRequest.rejectedAt

any

Date when the signature request was rejected. Only present if rejected.

subject.termsInvite.witness.nom151

object

Individual NOM151 conservation strategy.

subject.termsInvite.witness.merkleized

object

Combined merkleized conservation strategy.

subject.termsInvite.witness.witnessCo

object

Witness conservation strategy.

subject.termsInvite.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

subject.termsInvite.witness.endorsable

object

subject.termsInvite.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

subject.termsInvite.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

subject.wallet

object

subject.wallet.id

string

required

subject.wallet.endorsables

object

subject.wallet.endorseFromEvents

object

subject.wallet.endorseToEvents

object

subject.wallet.subject

object

A subject is a person or an organization ("persona física o moral" in Spanish) identified by a certificate.

subject.wallet.subject.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.wallet.subject.commonName

string

required

Name of the subject.

subject.wallet.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

subject.wallet.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

subject.wallet.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

subject.wallet.subject.createdAt

any

required

subject.wallet.subject.updatedAt

any

required

subject.wallet.subject.country

any

Country of the subject.

subject.wallet.subject.emailAddress

any

Email address of the subject.

subject.wallet.subject.certificate

object

Certificate of the subject.

subject.wallet.subject.certificate.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.wallet.subject.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

subject.wallet.subject.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

subject.wallet.subject.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

subject.wallet.subject.certificate.notAfter

any

required

The latest date at which the certificate is valid.

subject.wallet.subject.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

subject.wallet.subject.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

subject.wallet.subject.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

subject.wallet.subject.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

subject.wallet.subject.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

subject.wallet.subject.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

subject.wallet.subject.certificate.createdAt

any

required

subject.wallet.subject.certificate.updatedAt

any

required

subject.wallet.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

subject.wallet.subject.termsInvite.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

subject.wallet.subject.termsInvite.signatureRequest

object

required

The signature request this invite is linked to.

subject.wallet.subject.termsInvite.subject

object

required

The subject this invite is linked to.

subject.wallet.subject.termsInvite.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

subject.wallet.subject.termsInvite.createdAt

any

required

subject.wallet.subject.termsInvite.updatedAt

any

required

subject.wallet.subject.termsInvite.certificate

object

The certificate this invite was signed with.

subject.wallet.subject.termsInvite.signature

any

The signature from the certificate as a hexadecimal string.

subject.wallet.subject.termsInvite.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

subject.wallet.subject.termsInvite.witness

object

Witness that attest the signature using a merkle proof

subject.wallet.subject.termsInvite.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

subject.wallet.subject.termsInvite.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

subject.wallet.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

subject.wallet.subject.wallet

object

Wallet Definition List Wallets

curl --request GET \
  --url https://api.plumaa.id/rest/v1/wallet/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "endorsables": {
    "items": [
      {
        "id": "<any>",
        "ownerId": "<string>",
        "timestamp": 123,
        "network": 123,
        "owner": {},
        "endorseEvents": {
          "items": [
            {
              "id": "<string>",
              "timestamp": 123,
              "fromId": "<string>",
              "toId": "<string>",
              "digest": "<any>",
              "network": 123,
              "from": {},
              "to": {},
              "token": {}
            }
          ],
          "pageInfo": {
            "hasNextPage": true,
            "hasPreviousPage": true,
            "startCursor": "<string>",
            "endCursor": "<string>"
          }
        },
        "witness": {
          "id": "<any>",
          "hash": "<any>",
          "algorithm": "SHA256",
          "initialOwner": {
            "id": "<any>",
            "commonName": "<string>",
            "serialNumber": "<string>",
            "country": "<any>",
            "RFC": "<string>",
            "emailAddress": "<any>",
            "certificate": {
              "id": "<any>",
              "serialNumber": "<any>",
              "issuer": {
                "id": "<any>",
                "RFC": "<string>",
                "hash": "<any>",
                "commonName": "<string>",
                "organization": "<string>",
                "organizationalUnitName": "<string>",
                "emailAddress": "<any>",
                "streetAddress": "<string>",
                "postalCode": 123,
                "country": "<any>",
                "stateOrProvinceName": "<string>",
                "localityName": "<string>",
                "publicKey": {
                  "exponent": "<any>",
                  "modulus": "<any>"
                },
                "certificatePem": "<string>",
                "createdAt": "<any>",
                "updatedAt": "<any>"
              },
              "notBefore": "<any>",
              "notAfter": "<any>",
              "subject": {},
              "publicKey": {
                "exponent": "<any>",
                "modulus": "<any>"
              },
              "version": "<any>",
              "hash": "<any>",
              "certificatePem": "<string>",
              "revoked": true,
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "termsInvite": {
              "id": "<any>",
              "signatureRequest": {
                "id": "<any>",
                "draft": true,
                "finalized": true,
                "name": "<string>",
                "content": {
                  "id": "<any>",
                  "raw": "<any>"
                },
                "anonymousKey": "<string>",
                "organization": {
                  "id": "<any>",
                  "name": "<string>",
                  "logo": "<any>",
                  "emailAddress": "<any>",
                  "quota": {
                    "id": "<any>",
                    "API": true,
                    "groupedNOM151": 123,
                    "nom151": 123
                  },
                  "policies": {
                    "signatureRequest": {
                      "conservation": "NOM151"
                    }
                  },
                  "createdAt": "<any>",
                  "updatedAt": "<any>"
                },
                "witness": {},
                "invites": [
                  {}
                ],
                "signed": "<any>",
                "pending": "<any>",
                "rejected": "<any>",
                "rejectedAt": "<any>",
                "createdAt": "<any>",
                "updatedAt": "<any>"
              },
              "subject": {},
              "certificate": {
                "id": "<any>",
                "serialNumber": "<any>",
                "issuer": {
                  "id": "<any>",
                  "RFC": "<string>",
                  "hash": "<any>",
                  "commonName": "<string>",
                  "organization": "<string>",
                  "organizationalUnitName": "<string>",
                  "emailAddress": "<any>",
                  "streetAddress": "<string>",
                  "postalCode": 123,
                  "country": "<any>",
                  "stateOrProvinceName": "<string>",
                  "localityName": "<string>",
                  "publicKey": {
                    "exponent": "<any>",
                    "modulus": "<any>"
                  },
                  "certificatePem": "<string>",
                  "createdAt": "<any>",
                  "updatedAt": "<any>"
                },
                "notBefore": "<any>",
                "notAfter": "<any>",
                "subject": {},
                "publicKey": {
                  "exponent": "<any>",
                  "modulus": "<any>"
                },
                "version": "<any>",
                "hash": "<any>",
                "certificatePem": "<string>",
                "revoked": true,
                "createdAt": "<any>",
                "updatedAt": "<any>"
              },
              "signature": "<any>",
              "ocspResponse": "<any>",
              "witness": {},
              "status": "PENDING",
              "rejectedAt": "<any>",
              "signedAt": "<any>",
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "pushNotificationToken": "<string>",
            "EVMAddress": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "wallet": {}
          },
          "claiming": {
            "id": "<any>",
            "authorizer": "<any>",
            "signature": "<any>",
            "claimer": "<any>",
            "network": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "claimed": true,
          "signatureRequest": {
            "id": "<any>",
            "draft": true,
            "finalized": true,
            "name": "<string>",
            "content": {
              "id": "<any>",
              "raw": "<any>"
            },
            "anonymousKey": "<string>",
            "organization": {
              "id": "<any>",
              "name": "<string>",
              "logo": "<any>",
              "emailAddress": "<any>",
              "quota": {
                "id": "<any>",
                "API": true,
                "groupedNOM151": 123,
                "nom151": 123
              },
              "policies": {
                "signatureRequest": {
                  "conservation": "NOM151"
                }
              },
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "witness": {},
            "invites": [
              {}
            ],
            "signed": "<any>",
            "pending": "<any>",
            "rejected": "<any>",
            "rejectedAt": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "organization": {
            "id": "<any>",
            "name": "<string>",
            "logo": "<any>",
            "emailAddress": "<any>",
            "quota": {
              "id": "<any>",
              "API": true,
              "groupedNOM151": 123,
              "nom151": 123
            },
            "policies": {
              "signatureRequest": {
                "conservation": "NOM151"
              }
            },
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "nom151": {
            "provider": "CINCEL",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "merkleized": {
            "txHash": "<any>",
            "network": "<any>",
            "merkleProof": [
              "<any>"
            ],
            "merkleRoot": "<any>",
            "nom151Provider": "CINCEL",
            "algorithm": "SHA256",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "witnessCo": {
            "timestamp": "<any>",
            "leafIndex": "<any>",
            "leftHashes": [
              "<any>"
            ],
            "rightHashes": [
              "<any>"
            ],
            "targetRootHash": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>"
          },
          "timestampedAt": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "endorsable": {}
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "endorseFromEvents": {
    "items": [
      {
        "id": "<string>",
        "timestamp": 123,
        "fromId": "<string>",
        "toId": "<string>",
        "digest": "<any>",
        "network": 123,
        "from": {},
        "to": {},
        "token": {}
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "endorseToEvents": {
    "items": [
      {
        "id": "<string>",
        "timestamp": 123,
        "fromId": "<string>",
        "toId": "<string>",
        "digest": "<any>",
        "network": 123,
        "from": {},
        "to": {},
        "token": {}
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "<string>",
      "endCursor": "<string>"
    }
  },
  "subject": {
    "id": "<any>",
    "commonName": "<string>",
    "serialNumber": "<string>",
    "country": "<any>",
    "RFC": "<string>",
    "emailAddress": "<any>",
    "certificate": {
      "id": "<any>",
      "serialNumber": "<any>",
      "issuer": {
        "id": "<any>",
        "RFC": "<string>",
        "hash": "<any>",
        "commonName": "<string>",
        "organization": "<string>",
        "organizationalUnitName": "<string>",
        "emailAddress": "<any>",
        "streetAddress": "<string>",
        "postalCode": 123,
        "country": "<any>",
        "stateOrProvinceName": "<string>",
        "localityName": "<string>",
        "publicKey": {
          "exponent": "<any>",
          "modulus": "<any>"
        },
        "certificatePem": "<string>",
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "notBefore": "<any>",
      "notAfter": "<any>",
      "subject": {},
      "publicKey": {
        "exponent": "<any>",
        "modulus": "<any>"
      },
      "version": "<any>",
      "hash": "<any>",
      "certificatePem": "<string>",
      "revoked": true,
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "termsInvite": {
      "id": "<any>",
      "signatureRequest": {
        "id": "<any>",
        "draft": true,
        "finalized": true,
        "name": "<string>",
        "content": {
          "id": "<any>",
          "raw": "<any>"
        },
        "anonymousKey": "<string>",
        "organization": {
          "id": "<any>",
          "name": "<string>",
          "logo": "<any>",
          "emailAddress": "<any>",
          "quota": {
            "id": "<any>",
            "API": true,
            "groupedNOM151": 123,
            "nom151": 123
          },
          "policies": {
            "signatureRequest": {
              "conservation": "NOM151"
            }
          },
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "witness": {},
        "invites": [
          {}
        ],
        "signed": "<any>",
        "pending": "<any>",
        "rejected": "<any>",
        "rejectedAt": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "subject": {},
      "certificate": {
        "id": "<any>",
        "serialNumber": "<any>",
        "issuer": {
          "id": "<any>",
          "RFC": "<string>",
          "hash": "<any>",
          "commonName": "<string>",
          "organization": "<string>",
          "organizationalUnitName": "<string>",
          "emailAddress": "<any>",
          "streetAddress": "<string>",
          "postalCode": 123,
          "country": "<any>",
          "stateOrProvinceName": "<string>",
          "localityName": "<string>",
          "publicKey": {
            "exponent": "<any>",
            "modulus": "<any>"
          },
          "certificatePem": "<string>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "notBefore": "<any>",
        "notAfter": "<any>",
        "subject": {},
        "publicKey": {
          "exponent": "<any>",
          "modulus": "<any>"
        },
        "version": "<any>",
        "hash": "<any>",
        "certificatePem": "<string>",
        "revoked": true,
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "signature": "<any>",
      "ocspResponse": "<any>",
      "witness": {},
      "status": "PENDING",
      "rejectedAt": "<any>",
      "signedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "pushNotificationToken": "<string>",
    "EVMAddress": "<any>",
    "createdAt": "<any>",
    "updatedAt": "<any>",
    "wallet": {}
  }
}

Introduction

Certificate

Issuer

Organization

Signature Request Invite

Signature Request

Subject

Witness

Wallet

Endorsable

Endorse Event

API Key

Organization Link

Organization Member

Timeseries

Price Oracle

Other

Authorizations

Path Parameters

Query Parameters

Response