{
  "opencollection": "1.0.0",
  "info": {
    "name": "Orum Authentication Persons API",
    "version": "v2022-09-21"
  },
  "items": [
    {
      "info": {
        "name": "Persons",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all persons",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.orum.io/deliver/persons",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "index",
                "value": "",
                "type": "query",
                "description": "Index for paginated results"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Max number of results to return"
              },
              {
                "name": "customer_reference_id",
                "value": "",
                "type": "query",
                "description": "Filter by customer reference id"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by customer statuses (multiple allowed)"
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "Filter results created at or after this time"
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "Filter results created before this time"
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query",
                "description": "The first name to filter persons by (case-insensitive, exact match)."
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query",
                "description": "The last name to filter persons by (case-insensitive, exact match)."
              },
              {
                "name": "account_number",
                "value": "",
                "type": "query",
                "description": "Filter by account number"
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Filter results by the person id"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get all persons objects."
        },
        {
          "info": {
            "name": "Create a person",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.orum.io/deliver/persons",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a person object to represent a human customer."
        },
        {
          "info": {
            "name": "Update a person by customer reference id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.orum.io/deliver/persons",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update a person object using its reference id."
        },
        {
          "info": {
            "name": "Get a person by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.orum.io/deliver/persons/:id",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Orum generated unique id for the person resource you are fetching."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a person object."
        },
        {
          "info": {
            "name": "Update a person by id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.orum.io/deliver/persons/:id",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Orum generated unique id for the person resource you are updating."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update a person object by its id."
        },
        {
          "info": {
            "name": "Partial update a person by id",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.orum.io/deliver/persons/:id",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Orum generated unique id for the resource for the person resource you are updating."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update individual fields on person object."
        },
        {
          "info": {
            "name": "Closes a person by id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.orum.io/deliver/persons/:id",
            "headers": [
              {
                "name": "Orum-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Orum generated unique id for the resource for the person resource you are updating."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-sandbox.orum.io/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Close a person object so they are unable to transact."
        }
      ]
    }
  ],
  "bundled": true
}