Get project consent settings

Projects

Get project consent settings

Last updated August 23, 2026

get/v1/projects/{projectId}/consent

Authentication

bearerAuth

bearerAuth: http / bearer — Use an Inth API key or OAuth access token in the Authorization header.

Request

Path Parameters

Name	Type	Required	Description
`projectId`	`string`	Required	Project identifier.

Responses

`200`

Linked consent instance settings for the project.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`data`	`object`	Required	—
`data.instanceId`	`string`	Required	—
`data.instanceSlug`	`string`	Required	—
`data.instanceName`	`string`	Required	—
`data.trustedOrigins`	`string[]`	Required	—
`data.branding`	`"inth" \| "c15t" \| "none"`	Required	Branding shown in the consent banner. Removing branding with 'none' requires an eligible paid plan.
`data.backendURL`	`string \| null`	Required	—
`data.dashboardURL`	`string (uri)`	Required	—
`data.backendVersion`	`string`	Required	—

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": true
    },
    "data": {
      "type": "object",
      "required": [
        "instanceId",
        "instanceSlug",
        "instanceName",
        "trustedOrigins",
        "branding",
        "backendURL",
        "dashboardURL",
        "backendVersion"
      ],
      "properties": {
        "instanceId": {
          "type": "string"
        },
        "instanceSlug": {
          "type": "string"
        },
        "instanceName": {
          "type": "string"
        },
        "trustedOrigins": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "branding": {
          "type": "string",
          "enum": [
            "inth",
            "c15t",
            "none"
          ],
          "description": "Branding shown in the consent banner. Removing branding with 'none' requires an eligible paid plan."
        },
        "backendURL": {
          "oneOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "null"
            }
          ]
        },
        "dashboardURL": {
          "type": "string",
          "format": "uri"
        },
        "backendVersion": {
          "type": "string"
        }
      }
    }
  }
}

`400`

The request payload or parameters are invalid.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`401`

Authentication is missing, invalid, or expired.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`402`

The requested operation requires a paid plan. API access (organization API keys) requires the Starter plan or higher; a downgraded organization receives this error until its plan is restored.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`403`

The authenticated principal cannot access the resource.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`404`

The requested resource was not found.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`429`

The rate limit was exceeded. API key limits are set by plan tier (Starter 600/min, Pro 1500/min, Enterprise 3000/min). Check the Retry-After header before retrying.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`500`

An unexpected internal error occurred.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSTANCE_LIMIT_REACHED" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSTANCE_LIMIT_REACHED",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

REST API overview: Every operation in this API.

Examples

const response = await fetch("https://api.inth.com/v1/projects/prj_123/consent", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});
const data = await response.json();

Response · 200

Example: default

{
  "success": true,
  "data": {
    "instanceId": "ins_123",
    "instanceSlug": "website",
    "instanceName": "Website",
    "trustedOrigins": [
      "example.com",
      "*.example.com"
    ],
    "branding": "inth",
    "backendURL": "https://website-acme.inth.app/",
    "dashboardURL": "https://inth.com/dashboard/acme/website/consent/overview",
    "backendVersion": "v2"
  }
}

Response · 400

Example: default

{
  "success": false,
  "error": {
    "code": "INVALID_PAYLOAD",
    "message": "Invalid request payload",
    "details": [
      {
        "code": "too_small",
        "message": "Too small: expected string to have >=1 characters",
        "path": [
          "name"
        ]
      }
    ]
  }
}

Response · 401

Example: default

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}

Response · 402

Example: default

{
  "success": false,
  "error": {
    "code": "PLAN_REQUIRED",
    "message": "API access requires the Starter plan or higher"
  }
}

Response · 403

Example

{
  "success": true,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": {}
  }
}

Response · 404

Example

{
  "success": true,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": {}
  }
}

Response · 429

Example: default

{
  "success": false,
  "error": {
    "code": "RATE_LIMITED",
    "message": "API key rate limit exceeded"
  }
}

Response · 500

Example: default

{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}