User
9 endpoints
POST
/users/individual-person
Create individual person user
Create an individual person. Required fields are configurable.
Request Body
generalConditions required
Date when general conditions were accepted
idNumber
Identification number
idType
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 99: Other
idExpireDate
ID expire date
name
First name
middleName
Middle name
surname
Surname
secondLastName
Second Last Name
dateOfBirth
Date of birth
phoneNumber
Phone Number
nationality
Nationality
residenceCountry
Country of residence
countryOfBirth
Country of Birth
address
Address
postalCode
Postal Code
device
Device name or user agent
ip
User's IP address
professionalActivity
Professional activity. Values: 1: Self employed, 2: Employed, 3: Unemployed, 4: Student, 99: Other
professionalActivitySector
Professional activity sector. CNO: A-P
businessRelationshipQuestionnaire
Business relation questionnaire in JSON format.
sourceOfFundsQuestionnaire
Source of funds questionnaire in JSON format.
email
User email
addressCity
Name of city of current residence
businessSector
Client's business sector. Allowed values: (1-20 | 99)
businessRelationship
Purpose of the business relationship. Allowed values: A-D
sourceOfFunds
Source of client funds. Allowed values: 1-9
pep
Boolean to know if the indivual person is a pep (person with public responsibility)
sanctions
Boolean to know if the indivual person has any sanctions
externalReference
Reference to external client id
Responses
201
400
Bad request
401
Unauthorized
404
Files not found
409
Already exists
POST https://api.qa.onyze.pro/v1/users/individual-person
Request body
{
"generalConditions": "2020-11-08T17:49:15+00:00",
"idNumber": "X5748125C",
"idType": "1",
"idExpireDate": "2021-12-10T00:00:00+00:00",
"name": "John",
"middleName": "Andrei",
"surname": "Sanderson",
"secondLastName": "Garcia",
"dateOfBirth": "1985-11-08T00:00:00+00:00",
"phoneNumber": "+34634761346",
"nationality": "ES",
"residenceCountry": "ES"
}
Response 201
{
"id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231"
}
POST
/users/legal-person
Create legal person user
Create a legal person. Required fields are configurable.
Request Body
generalConditions required
Date when general conditions were accepted
device required
Device name or user agent
ip required
User's IP address
idNumber required
Identification number
legalName required
Legal name
phoneNumber required
Corporate or support phone number
email required
Corporate or support email
tradename required
Trade name
companyType required
Company type. Allowed values: 1-40
constitutionDate required
Constitution date
constitutionPlace required
Constitution place
taxResidence required
Tax residence
CNAE required
CNAE Code
registeredOffice required
Registered office
mainOffice required
Main office
countriesBusinessActivity
Countries business activity
individualsCompany required
Individuals with more than 25% of the company (max 4)
name required
Name
surnames required
Surnames
nationality
Nationality
idType required
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 99: Other
idNumber required
Identification number
companyAdministrationCommittee required
Company administration committee
name required
Name
surnames required
Surnames
address required
Address
idType required
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 99: Other
idNumber required
Identification number
position required
Position
adminPersonName required
Administrator person name
adminPersonIdType required
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 4: CIF, 99: Other
adminPersonIdNumber required
Identification number of the administrator
representativeIdType required
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 4: CIF, 99: Other
representativeIdNumber required
Identification number of the representative
annualRevenueVolume required
Approximate annual revenue volume
contractedServices required
Contracted services
purposeBusinessRelationship required
Purpose business relationship. Allowed values: 1-4
numExpectedTransactions required
Number of expected transactions
expectedAmountToCustodyFirstYear required
Expected amount to be custodied (first year)
externalReference
Reference to external client id
Responses
201
400
Bad request
401
Unauthorized
404
Files not found
409
Already exists
POST https://api.qa.onyze.pro/v1/users/legal-person
Request body
{
"generalConditions": "2020-11-08T17:49:15+00:00",
"device": "Mozilla/5.0 (Android; Mobile; rv:13.0) Gecko/13.0 Firefox/13.0",
"ip": "167.145.132.65",
"idNumber": "X5748125C",
"legalName": "string",
"phoneNumber": "+34634761346",
"email": "example@onyze.com",
"tradename": "string",
"companyType": "1",
"constitutionDate": "2020-11-08T17:49:15+00:00",
"constitutionPlace": "{\n \"country\": \"ES\",\n \"city\": \"Madrid\",\n \"postalCode\": \"28034\",\n \"address\": \"Calle de Embajadores, 9\"\n }",
"taxResidence": "{\n \"country\": \"ES\",\n \"city\": \"Madrid\",\n \"postalCode\": \"28034\",\n \"address\": \"Calle de Embajadores, 9\"\n }"
}
Response 201
{
"id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231"
}
GET
/users
List all users
List all existing users. Admin audience is required.
Parameters
externalReference
Reference to external user ID
email
User email
idNumber
User id number
page
Page number of the records list
limit
Max number of records by page. limit=0 to return all records
sort
Sort the response PARAM or -PARAM
createdAfter
Created after date
createdBefore
Created before date
Responses
200
401
Unauthorized
404
Not found
GET https://api.qa.onyze.pro/v1/users
Response 200
[
{
"id": "d8vJIh-H",
"createdAt": "2018-08-17T17:04:55.626Z",
"updatedAt": "2018-08-21T18:24:17.185Z",
"generalConditions": "2020-08-07T12:29:11.214Z",
"idNumber": "string",
"email": "string",
"individualPerson": {
"idNumber": "B00000000",
"name": "Alice",
"surname": "Lopez",
"middleName": "Andrea",
"email": "alice@email.com"
},
"legalPerson": {
"generalConditions": "2020-11-08T17:49:15+00:00",
"device": "Mozilla/5.0 (Android; Mobile; rv:13.0) Gecko/13.0 Firefox/13.0",
"ip": "167.145.132.65",
"idNumber": "X5748125C",
"legalName": "string"
},
"blocked": true,
"externalReference": "string"
}
]
GET
/users/{user}
Find a user by id
Find an existing user by its id.
Parameters
user required
id parameter must be included in the URI
Responses
200
401
Unauthorized
404
Not found
GET https://api.qa.onyze.pro/v1/users/{user}
Response 200
{
"id": "d8vJIh-H",
"createdAt": "2018-08-17T17:04:55.626Z",
"updatedAt": "2018-08-21T18:24:17.185Z",
"generalConditions": "2020-08-07T12:29:11.214Z",
"idNumber": "string",
"email": "string",
"individualPerson": {
"idNumber": "B00000000",
"name": "Alice",
"surname": "Lopez",
"middleName": "Andrea",
"email": "alice@email.com"
},
"legalPerson": {
"generalConditions": "2020-11-08T17:49:15+00:00",
"device": "Mozilla/5.0 (Android; Mobile; rv:13.0) Gecko/13.0 Firefox/13.0",
"ip": "167.145.132.65",
"idNumber": "X5748125C",
"legalName": "string"
},
"blocked": true,
"externalReference": "string"
}
DELETE
/users/{user}
Delete a user by id
Delete an existing user.
Parameters
user required
id parameter must be included in the URI
Request Body
device required
Device name or user agent
ip required
User's IP address
Responses
401
Unauthorized
403
Cannot delete user that has wallets. Wallets must be deleted first
404
Not found
DELETE https://api.qa.onyze.pro/v1/users/{user}
Request body
{
"device": "Mozilla/5.0 (Android; Mobile; rv:13.0) Gecko/13.0 Firefox/13.0",
"ip": "167.145.132.65"
}
PATCH
/users/{user}/individual-person
Update individual person
Update an existing individual person.
Parameters
user required
id parameter must be included in the URI
Request Body
generalConditions
idNumber
idExpireDate
idType
name
status
middleName
surname
secondLastName
dateOfBirth
phoneNumber
nationality
residenceCountry
countryOfBirth
address
postalCode
device
ip
businessRelationshipQuestionnaire
sourceOfFundsQuestionnaire
email
addressCity
businessSector
businessRelationship
sourceOfFunds
professionalActivity
professionalActivitySector
pep
sanctions
externalReference
Responses
200
400
Bad request
401
Unauthorized
404
Not found
PATCH https://api.qa.onyze.pro/v1/users/{user}/individual-person
Request body
{
"generalConditions": "string",
"idNumber": "string",
"idExpireDate": "string",
"idType": "string",
"name": "string",
"status": "string",
"middleName": "string",
"surname": "string",
"secondLastName": "string",
"dateOfBirth": "string",
"phoneNumber": "string",
"nationality": "string"
}
Response 200
{
"id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231"
}
PATCH
/users/{user}/legal-person
Update a legal person
Update an existing legal person.
Parameters
user required
id parameter must be included in the URI
Request Body
generalConditions
device
ip
idNumber
legalName
phoneNumber
email
tradename
companyType
constitutionDate
constitutionPlace
country required
Country
city required
City
postalCode required
Postal Code
address required
Address
taxResidence
country required
Country
city required
City
postalCode required
Postal Code
address required
Address
CNAE
registeredOffice
country required
Country
city required
City
postalCode required
Postal Code
address required
Address
mainOffice
country required
Country
city required
City
postalCode required
Postal Code
address required
Address
countriesBusinessActivity
individualsCompany
name required
Name
surnames required
Surnames
nationality
Nationality
idType required
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 99: Other
idNumber required
Identification number
companyAdministrationCommittee
name required
Name
surnames required
Surnames
address required
Address
idType required
Type of ID: 1: identity card, 2: Passport, 3: Driving License, 99: Other
idNumber required
Identification number
position required
Position
adminPersonName
adminPersonIdType
adminPersonIdNumber
representativeIdType
representativeIdNumber
annualRevenueVolume
contractedServices
purposeBusinessRelationship
numExpectedTransactions
expectedAmountToCustodyFirstYear
externalReference
Responses
200
400
Bad request
401
Unauthorized
404
Not found
PATCH https://api.qa.onyze.pro/v1/users/{user}/legal-person
Request body
{
"generalConditions": "string",
"device": "string",
"ip": "string",
"idNumber": "string",
"legalName": "string",
"phoneNumber": "string",
"email": "string",
"tradename": "string",
"companyType": "string",
"constitutionDate": "2026-01-15T10:30:00Z",
"constitutionPlace": {
"country": "US",
"city": "Madrid",
"postalCode": "28012",
"address": "Calle de Embajadores, 9"
},
"taxResidence": "..."
}
Response 200
{
"id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231"
}
GET
/users/{user}/wallets/{wallet}/whitelists
List all whitelists
Endpoint to list all existing whitelist request for a user and wallet.
Parameters
user required
id parameter must be included in the URI
wallet required
id parameter must be included in the URI
page
Page number of the records list
limit
Max number of records by page. limit=0 to return all records
sort
Sort the response PARAM or -PARAM
createdAfter
Created after date
createdBefore
Created before date
Responses
200
400
Bad request
403
Token expired or revoked
404
Not found
GET https://api.qa.onyze.pro/v1/users/{user}/wallets/{wallet}/whitelists
Response 200
[
{}
]
GET
/users/{user}/wallets/{wallet}/whitelists/{whitelist}
Find a whitelist by ID
Find an existing whitelist by its id.
Parameters
user required
id parameter must be included in the URI
wallet required
id parameter must be included in the URI
whitelist required
id parameter must be included in the URI
Responses
200
400
Bad request
403
Token expired or revoked
404
Not found
GET https://api.qa.onyze.pro/v1/users/{user}/wallets/{wallet}/whitelists/{whitelist}
Response 200
{
"id": "d8vJIh-H",
"createdAt": "2018-08-17T17:04:55.626Z",
"updatedAt": "2018-08-21T18:24:17.185Z",
"userId": "yKcj7qVJ7j",
"userFullName": "Pepe García Márquez",
"counterPartyFullName": "Antonio González Cano",
"walletId": "PNldGOuW_",
"assetId": "JPGI4JJAx",
"counterPartyType": "CASP",
"travelRuleStatus": "verified",
"tenantId": "tenant-1",
"casp": {}
}