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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

Response

200 - application/json

An Organization Link is a connection between an Organization and a Subject. It allows the Organization to send signing requests to the 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
object
required

The Subject.

​
organization
object
required

The Organization.

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

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