Skip to main content
Create User
curl --request POST \
  --url https://api.yapily.com/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "applicationUserId": "string"
}
'
{
  "uuid": "1ec8e814-085e-46ad-a303-3fe11808f67e",
  "applicationUuid": "50935110-c7df-4003-a06a-1cc5fd4643c9",
  "applicationUserId": "string",
  "createdAt": "2022-10-17T08:51:02.463Z",
  "institutionConsents": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.yapily.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Body

application/json;charset=UTF-8

Details of a new user to be created for the application.

​
applicationUserId
string

Optional. The unique identifier of the Application User assigned by the Application Owner.

Example:

"user-234562290"

​
referenceId
string

Deprecated. A non-unique reference Id for the Application User.

​
vopOptOut
boolean
default:false

Optional. A flag to indicate whether the user has opted out of VOP.

Response

Created

Information about a user of an application.

​
uuid
string<uuid>

A unique identifier for the 'User' assigned by Yapily.

​
applicationUuid
string<uuid>

Unique identifier of the application the user is associated with.

​
applicationUserId
string

Conditional. The user-friendly reference to the User.

​
referenceId
string
​
createdAt
string<date-time>

Date and time of when the user was created.

​
institutionConsents
object[]
​
vopOptOut
boolean
default:false

Optional. A flag to indicate whether the user has opted out of VOP.