Skip to main content
API docs by Redocly

HolyWally.PartnerApi (1.0)

Download OpenAPI specification:Download

Invitation

/invitation/check

query Parameters
emailOrPhoneNumber
string

Responses

Notification

/notification

Request Body schema:
event_type
string or null
customer_identifier
string or null
event_fields
object or null

Responses

Request samples

Content type
{
  • "event_type": "string",
  • "customer_identifier": "string",
  • "event_fields": { }
}

Response samples

Content type
No sample

Policy

/policies

Responses

Response samples

Content type
No sample

Preset

/account-presets

Responses

Response samples

Content type
No sample

User

/users

Request Body schema:
firstName
required
string non-empty
lastName
required
string non-empty
userDirectoryIds
required
Array of strings <uuid> non-empty
externalRefIds
Array of strings or null
object (UserDetailsModel)

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "userDirectoryIds": [
    ],
  • "externalRefIds": [
    ],
  • "userDetails": {
    }
}

Response samples

Content type
No sample

/users

Responses

Response samples

Content type
No sample

/users/{externalRefId}

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

/users/invite

Request Body schema:
email
required
string non-empty
phoneNumber
required
string non-empty

Responses

Request samples

Content type
{
  • "email": "string",
  • "phoneNumber": "string"
}

Response samples

Content type
No sample

/users/{externalRefId}/alias

path Parameters
externalRefId
required
string
Request Body schema:
Array
externalRefId
string or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/users/{externalRefId}/alias

path Parameters
externalRefId
required
string
Request Body schema:
Array
externalRefId
string or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/users/{externalRefId}/policies

path Parameters
externalRefId
required
string
Request Body schema:
Array
policyId
string <uuid>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/users/{externalRefId}/policies

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

/users/{externalRefId}/policies/{policyId}

path Parameters
externalRefId
required
string
policyId
required
string <uuid>

Responses

Response samples

Content type
No sample

/users/{externalRefId}/wallets

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

/users/{externalRefId}/wallets

path Parameters
externalRefId
required
string
Request Body schema:
Array
walletProviderId
required
string <uuid>
clientId
required
string non-empty

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/users/{externalRefId}/wallet

path Parameters
externalRefId
required
string
Request Body schema:
walletProviderId
required
string <uuid>
userDirectoryId
required
string <uuid>

Responses

Request samples

Content type
{
  • "walletProviderId": "3a3a4884-a3e5-495d-b788-32bc0931ea86",
  • "userDirectoryId": "998afdea-d5e9-4f7e-b844-5892d8a5b3aa"
}

Response samples

Content type
No sample

/users/{externalRefId}/assign-auth-account

path Parameters
externalRefId
required
string
Request Body schema:
authIdentifier
required
string non-empty
authenticationType
required
string non-empty

Responses

Request samples

Content type
{
  • "authIdentifier": "string",
  • "authenticationType": "string"
}

Response samples

Content type
No sample

/users/{externalRefId}/auth-account

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

/users/{externalRefId}/auth-account

path Parameters
externalRefId
required
string
Request Body schema:
Array
authIdentifier
string or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/users/{externalRefId}/activate

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

/users/{externalRefId}/suspend

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

/users/{externalRefId}/close

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

UserDirectory

/user-directories

Responses

Response samples

Content type
No sample

/user-directories

Request Body schema:
name
required
string non-empty
externalRefIds
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "externalRefIds": [
    ]
}

Response samples

Content type
No sample

/user-directories/{externalRefId}

path Parameters
externalRefId
required
string
Request Body schema:
name
required
string non-empty
externalRefIds
Array of strings or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "externalRefIds": [
    ]
}

Response samples

Content type
No sample

/user-directories/{externalRefId}

path Parameters
externalRefId
required
string

Responses

Response samples

Content type
No sample

Wallet

/wallets

Responses

Response samples

Content type
No sample

/wallets/{walletId}/wallet-providers

path Parameters
walletId
required
string <uuid>

Responses

Response samples

Content type
No sample