POST
/
institutions
/
oauth
/
create
Create OAuth Application
curl --request POST \
  --url https://sandbox-api.cardcore.cloud/institutions/oauth/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Banking App",
  "description": "Banking application for managing customer accounts and transactions",
  "publicKey": "-----BEGIN CERTIFICATE-----\nMIIBIjANBgkq...\n-----END CERTIFICATE-----",
  "scopes": [
    "READ",
    "WRITE"
  ],
  "grantType": "client_credentials",
  "websiteUrl": "https://myapp.com",
  "iconUrl": "https://myapp.com/icon.png",
  "isOfficial": false
}
'
{
  "statusCode": 200,
  "message": "Institution OAuth created successfully."
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

The name your team will use to recognize this app.

Example:

"My Banking App"

​
publicKey
string
required

The certificate public key for this app. Paste the content of the public key certificate you generated for the app.

Example:

"-----BEGIN CERTIFICATE-----\nMIIBIjANBgkq...\n-----END CERTIFICATE-----"

​
scopes
string[]
required

The permissions this app should have.

Example:
["READ", "WRITE"]
​
grantType
enum<string>
required

How this app will request access. Use client_credentials for server-to-server access, or authorization_code when a user must approve access.

Available options:
client_credentials,
authorization_code,
refresh_token
Example:

"client_credentials"

​
description
string

A short note that explains what this app is for.

Example:

"App used by our mobile banking customers"

​
redirectUri
string<uri>[]

The web addresses the system can send users back to after they approve access. Required when grantType is authorization_code.

Example:
[
  "https://myapp.com/callback",
  "https://myapp.com/oauth/callback"
]
​
websiteUrl
string<uri>

The website for this app or business.

Example:

"https://myapp.com"

​
iconUrl
string<uri>

A link to the app's logo or icon.

Example:

"https://myapp.com/icon.png"

​
isOfficial
boolean

Set this to true if this is an official app owned by your institution.

Example:

false

Response

201 - application/json

Create OAuth Application completed successfully.

The response is of type object.