---
title: "Create credential"
method: POST
path: "/credentials"
tags: ["Credentials"]
---

# Create credential

`POST /credentials`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/credentials`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/credentials/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a credential.
### Authorization Required:
  - Designer Administrator

## Request body

- CredentialRequest
  - `clientId` string, required: Client ID of the credential.
  - `clientSecret` string, required: Client secret of the credential.
  - `description` string: Description of the credential.
  - `designerRoles` string: Creator roles of the credential.
  - `expressRoles` string: Express roles of the credential.
  - `name` string, required: Name of the credential.

## Response `200`

JSON describing the created credential

- CredentialResponse
  - `clientId` string, required: Client ID of the credential.
  - `name` string, required: Name of the credential.
  - `role` string, required: Express role of the credential.
  - `roles` string[], required: Creator or Express roles of the credential.
  - `groups` string[]: Express groups of the credential.
  - `applicationRoles` object: Application Express roles of the credential.
  - `created` string, required: Date of when the credential was created.
  - `modified` string: Date of when the credential was modified.
  - `status` string, required: Status of the credential.
  - `credentialType` string, required: Type of the credential (Creator or Express).
  - `expireDate` string: Date of when the credential expires.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)