- Documentation
- SEPA's API
- API Explore
- Community
- Welcome to FinHub
- GETGet document
- GETGet documents
- GETGet verification result
- POSTPost document upload
- PUTPut document status
- PUTPut document update
- GETGet card balance
- GETGet card pin
- GETGet card product config
- GETGet card product list
- GETGet card product
- GETGet card transactions
- GETGet card usage
- GETGet card
- GETGet cardholder
- GETGet EHIMode configuration
- GETGet issuer
- POSTPost card credit
- POSTPost card debit
- POSTPost card product setup
- POSTPost card product
- POSTPost card transfers
- POSTPost card usage
- POSTPost card
- POSTPost cardholder
- POSTPost EHIMode configuration
- POSTPost issuer
- PUTPut card account
- PUTPut card activate
- PUTPut card cardholder
- PUTPut card lost
- PUTPut card pin
- PUTPut card product config
- PUTPut card stolen
- PUTPut card suspend
- PUTPut cardholder
- PUTPut EHIMode configuration
- PUTPut issuer
- Private
- Public
- 2FA
- AccessControl
- Active Session
- Credentials
- Customer
- Organization
- PATCHCreate business address
- POSTCreate business customer documents
- POSTCreate Organization Bulk
- POSTCreate Organization by Customer Type
- POSTCreate Organization
- DELDelete organization entity
- DELDelete organization shareholder delete
- POSTGet Organization By Business Type
- POSTGet Organization By Customer Type
- GETGet Organization Details
- GETGet organization documents by purpose
- GETGet organization documents
- GETGet organization entity
- GETGet organization get address
- GETGet organization get by id
- GETGet organization get customers
- GETGet organization shareholder get
- PATCHPatch organization entity create
- PATCHPatch organization entity update
- PATCHPatch organization shareholder create
- PATCHPatch organization shareholder update
- POSTPost organization get all
- PUTPut organization update kyb status
- PUTPut organization update status
- PUTUpdate Organization
- PATCH
- POSTPost send
- POSTGenerateToken
- IPG Backoffice APIs
- IPG Payment APIs
- Company
- EIN Verification
- IBAN Verification
- NIF Verification
- Product
- System
- TIN Verification
- VAT Verification
- POSTPost authorize
- POSTPost backgroundcheck
- POSTPost delete info
- POSTPost face
- POSTPost get info
- POSTPost scan documents
- POSTPost upload image
- PUTPut backgroundcheck
- Global Settings
- Rules
- Smart Contract
- Admin
- Allowed Operation
- Assets
- Currency
- Currency Pairs
- Dashboard
- Fee
- Limit
- Misc
- Operation Address
- Operation Destination
- Order
- Transactions
- Wallets
Introduction
AML
CMS
Crypto
Customer
muse-openapi
IPG
KYB
KYC
Smart Contract
Wallet
Organization
Patch organization shareholder update
PATCH
/
organization
/
shareholder
/
update
/
{organizationId}
Authorization
string
*
Bearer
Authorization
Required
string
The access token received from the authorization server in the OAuth 2.0 flow.
tenantId
string
*
tenantId
Required
string
Tenant/Owner id
organizationId
string
*
organizationId
Required
string
object
shareholders
object
shareholders
object
id
string
id
string
personFullname
string
personFullname
string
peerFullname
string
peerFullname
string
escliationFullname
string
escliationFullname
string
status
string
status
string
responsibility
string
responsibility
string
positions
string
positions
string
ownershipPercentage
string
ownershipPercentage
string
person
object
person
object
firstName
object
firstName
object
name
string
name
string
order
integer
order
integer
abbreviation
string
abbreviation
string
language
string
language
string
native
string
native
string
suffix
string
suffix
string
prefix
string
prefix
string
lastName
object
lastName
object
name
string
name
string
order
integer
order
integer
abbreviation
string
abbreviation
string
language
string
language
string
native
string
native
string
suffix
string
suffix
string
prefix
string
prefix
string
fullName
string
fullName
string
groupId
string
groupId
string
gender
enum<string>
gender
enum<string>
dateOfBirth
string
dateOfBirth
string
placeOfBirth
string
placeOfBirth
string
nationality
string
nationality
string
pinCode
string
pinCode
string
password
string
password
string
email
string
email
string
telephoneNumbers
array
telephoneNumbers
array
addresses
array
addresses
array
documents
array
documents
array
SecretQuestion
array
SecretQuestion
array
escallation
object
escallation
object
firstName
object
firstName
object
name
string
name
string
order
integer
order
integer
abbreviation
string
abbreviation
string
language
string
language
string
native
string
native
string
suffix
string
suffix
string
prefix
string
prefix
string
lastName
object
lastName
object
name
string
name
string
order
integer
order
integer
abbreviation
string
abbreviation
string
language
string
language
string
native
string
native
string
suffix
string
suffix
string
prefix
string
prefix
string
fullName
string
fullName
string
groupId
string
groupId
string
gender
enum<string>
gender
enum<string>
dateOfBirth
string
dateOfBirth
string
placeOfBirth
string
placeOfBirth
string
nationality
string
nationality
string
pinCode
string
pinCode
string
password
string
password
string
email
string
email
string
telephoneNumbers
array
telephoneNumbers
array
addresses
array
addresses
array
documents
array
documents
array
SecretQuestion
array
SecretQuestion
array
peers
object
peers
object
firstName
object
firstName
object
name
string
name
string
order
integer
order
integer
abbreviation
string
abbreviation
string
language
string
language
string
native
string
native
string
suffix
string
suffix
string
prefix
string
prefix
string
lastName
object
lastName
object
name
string
name
string
order
integer
order
integer
abbreviation
string
abbreviation
string
language
string
language
string
native
string
native
string
suffix
string
suffix
string
prefix
string
prefix
string
fullName
string
fullName
string
groupId
string
groupId
string
gender
enum<string>
gender
enum<string>
dateOfBirth
string
dateOfBirth
string
placeOfBirth
string
placeOfBirth
string
nationality
string
nationality
string
pinCode
string
pinCode
string
password
string
password
string
email
string
email
string
telephoneNumbers
array
telephoneNumbers
array
addresses
array
addresses
array
documents
array
documents
array
SecretQuestion
array
SecretQuestion
array
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
tenantId
string
requiredTenant/Owner id
Path Parameters
organizationId
string
requiredBody
application/json
shareholders
object
shareholders.id
string
shareholders.personFullname
string
shareholders.peerFullname
string
shareholders.escliationFullname
string
shareholders.status
string
shareholders.responsibility
string
shareholders.positions
string
shareholders.ownershipPercentage
string
shareholders.person
object
shareholders.person.firstName
object
shareholders.person.firstName.name
string
shareholders.person.firstName.order
integer
shareholders.person.firstName.abbreviation
string
shareholders.person.firstName.language
string
shareholders.person.firstName.native
string
shareholders.person.firstName.suffix
string
shareholders.person.firstName.prefix
string
shareholders.person.lastName
object
shareholders.person.lastName.name
string
shareholders.person.lastName.order
integer
shareholders.person.lastName.abbreviation
string
shareholders.person.lastName.language
string
shareholders.person.lastName.native
string
shareholders.person.lastName.suffix
string
shareholders.person.lastName.prefix
string
shareholders.person.fullName
string
shareholders.person.groupId
string
shareholders.person.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
shareholders.person.dateOfBirth
string
shareholders.person.placeOfBirth
string
shareholders.person.nationality
string
shareholders.person.pinCode
string
shareholders.person.password
string
shareholders.person.email
string
shareholders.person.telephoneNumbers
object[]
shareholders.person.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
shareholders.person.telephoneNumbers.operator
string
shareholders.person.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
shareholders.person.telephoneNumbers.country
string
shareholders.person.telephoneNumbers.number
string
shareholders.person.telephoneNumbers.purpose
string
shareholders.person.addresses
object[]
shareholders.person.addresses.addressPurpose
string
shareholders.person.addresses.address
object
shareholders.person.addresses.address.country
string
shareholders.person.addresses.address.area
string
shareholders.person.addresses.address.zipCode
string
shareholders.person.addresses.address.city
string
shareholders.person.addresses.address.street
string
shareholders.person.addresses.address.streetNumber
string[]
shareholders.person.addresses.address.building
string
shareholders.person.addresses.address.apartment
string
shareholders.person.addresses.address.entrance
string
shareholders.person.addresses.address.floor
string
shareholders.person.addresses.address.doorNumber
string
shareholders.person.addresses.address.geoPosition
object
shareholders.person.addresses.address.geoPosition.latitude
number
shareholders.person.addresses.address.geoPosition.longitude
number
shareholders.person.addresses.address.geoPosition.altitude
number
shareholders.person.addresses.address.alternative
object
shareholders.person.addresses.address.alternative.word1
string
shareholders.person.addresses.address.alternative.word2
string
shareholders.person.addresses.address.alternative.word3
string
shareholders.person.addresses.address.relatedToAddress
object[]
shareholders.person.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
shareholders.person.addresses.address.relatedToAddress.address
string
shareholders.person.addresses.address.additionalData
object[]
shareholders.person.addresses.address.additionalData.name
string
shareholders.person.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
shareholders.person.addresses.address.additionalData.value
string
shareholders.person.documents
object[]
shareholders.person.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
shareholders.person.documents.name
string
shareholders.person.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
shareholders.person.documents.location
string
shareholders.person.documents.verificationResponse
string
shareholders.person.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
shareholders.person.documents.metadata
object[]
shareholders.person.documents.metadata.name
string
shareholders.person.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
shareholders.person.documents.metadata.value
string
shareholders.person.SecretQuestion
object[]
shareholders.person.SecretQuestion.question
string
shareholders.person.SecretQuestion.answer
string
shareholders.escallation
object
shareholders.escallation.firstName
object
shareholders.escallation.firstName.name
string
shareholders.escallation.firstName.order
integer
shareholders.escallation.firstName.abbreviation
string
shareholders.escallation.firstName.language
string
shareholders.escallation.firstName.native
string
shareholders.escallation.firstName.suffix
string
shareholders.escallation.firstName.prefix
string
shareholders.escallation.lastName
object
shareholders.escallation.lastName.name
string
shareholders.escallation.lastName.order
integer
shareholders.escallation.lastName.abbreviation
string
shareholders.escallation.lastName.language
string
shareholders.escallation.lastName.native
string
shareholders.escallation.lastName.suffix
string
shareholders.escallation.lastName.prefix
string
shareholders.escallation.fullName
string
shareholders.escallation.groupId
string
shareholders.escallation.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
shareholders.escallation.dateOfBirth
string
shareholders.escallation.placeOfBirth
string
shareholders.escallation.nationality
string
shareholders.escallation.pinCode
string
shareholders.escallation.password
string
shareholders.escallation.email
string
shareholders.escallation.telephoneNumbers
object[]
shareholders.escallation.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
shareholders.escallation.telephoneNumbers.operator
string
shareholders.escallation.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
shareholders.escallation.telephoneNumbers.country
string
shareholders.escallation.telephoneNumbers.number
string
shareholders.escallation.telephoneNumbers.purpose
string
shareholders.escallation.addresses
object[]
shareholders.escallation.addresses.addressPurpose
string
shareholders.escallation.addresses.address
object
shareholders.escallation.addresses.address.country
string
shareholders.escallation.addresses.address.area
string
shareholders.escallation.addresses.address.zipCode
string
shareholders.escallation.addresses.address.city
string
shareholders.escallation.addresses.address.street
string
shareholders.escallation.addresses.address.streetNumber
string[]
shareholders.escallation.addresses.address.building
string
shareholders.escallation.addresses.address.apartment
string
shareholders.escallation.addresses.address.entrance
string
shareholders.escallation.addresses.address.floor
string
shareholders.escallation.addresses.address.doorNumber
string
shareholders.escallation.addresses.address.geoPosition
object
shareholders.escallation.addresses.address.geoPosition.latitude
number
shareholders.escallation.addresses.address.geoPosition.longitude
number
shareholders.escallation.addresses.address.geoPosition.altitude
number
shareholders.escallation.addresses.address.alternative
object
shareholders.escallation.addresses.address.alternative.word1
string
shareholders.escallation.addresses.address.alternative.word2
string
shareholders.escallation.addresses.address.alternative.word3
string
shareholders.escallation.addresses.address.relatedToAddress
object[]
shareholders.escallation.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
shareholders.escallation.addresses.address.relatedToAddress.address
string
shareholders.escallation.addresses.address.additionalData
object[]
shareholders.escallation.addresses.address.additionalData.name
string
shareholders.escallation.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
shareholders.escallation.addresses.address.additionalData.value
string
shareholders.escallation.documents
object[]
shareholders.escallation.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
shareholders.escallation.documents.name
string
shareholders.escallation.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
shareholders.escallation.documents.location
string
shareholders.escallation.documents.verificationResponse
string
shareholders.escallation.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
shareholders.escallation.documents.metadata
object[]
shareholders.escallation.documents.metadata.name
string
shareholders.escallation.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
shareholders.escallation.documents.metadata.value
string
shareholders.escallation.SecretQuestion
object[]
shareholders.escallation.SecretQuestion.question
string
shareholders.escallation.SecretQuestion.answer
string
shareholders.peers
object
shareholders.peers.firstName
object
shareholders.peers.firstName.name
string
shareholders.peers.firstName.order
integer
shareholders.peers.firstName.abbreviation
string
shareholders.peers.firstName.language
string
shareholders.peers.firstName.native
string
shareholders.peers.firstName.suffix
string
shareholders.peers.firstName.prefix
string
shareholders.peers.lastName
object
shareholders.peers.lastName.name
string
shareholders.peers.lastName.order
integer
shareholders.peers.lastName.abbreviation
string
shareholders.peers.lastName.language
string
shareholders.peers.lastName.native
string
shareholders.peers.lastName.suffix
string
shareholders.peers.lastName.prefix
string
shareholders.peers.fullName
string
shareholders.peers.groupId
string
shareholders.peers.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
shareholders.peers.dateOfBirth
string
shareholders.peers.placeOfBirth
string
shareholders.peers.nationality
string
shareholders.peers.pinCode
string
shareholders.peers.password
string
shareholders.peers.email
string
shareholders.peers.telephoneNumbers
object[]
shareholders.peers.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
shareholders.peers.telephoneNumbers.operator
string
shareholders.peers.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
shareholders.peers.telephoneNumbers.country
string
shareholders.peers.telephoneNumbers.number
string
shareholders.peers.telephoneNumbers.purpose
string
shareholders.peers.addresses
object[]
shareholders.peers.addresses.addressPurpose
string
shareholders.peers.addresses.address
object
shareholders.peers.addresses.address.country
string
shareholders.peers.addresses.address.area
string
shareholders.peers.addresses.address.zipCode
string
shareholders.peers.addresses.address.city
string
shareholders.peers.addresses.address.street
string
shareholders.peers.addresses.address.streetNumber
string[]
shareholders.peers.addresses.address.building
string
shareholders.peers.addresses.address.apartment
string
shareholders.peers.addresses.address.entrance
string
shareholders.peers.addresses.address.floor
string
shareholders.peers.addresses.address.doorNumber
string
shareholders.peers.addresses.address.geoPosition
object
shareholders.peers.addresses.address.geoPosition.latitude
number
shareholders.peers.addresses.address.geoPosition.longitude
number
shareholders.peers.addresses.address.geoPosition.altitude
number
shareholders.peers.addresses.address.alternative
object
shareholders.peers.addresses.address.alternative.word1
string
shareholders.peers.addresses.address.alternative.word2
string
shareholders.peers.addresses.address.alternative.word3
string
shareholders.peers.addresses.address.relatedToAddress
object[]
shareholders.peers.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
shareholders.peers.addresses.address.relatedToAddress.address
string
shareholders.peers.addresses.address.additionalData
object[]
shareholders.peers.addresses.address.additionalData.name
string
shareholders.peers.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
shareholders.peers.addresses.address.additionalData.value
string
shareholders.peers.documents
object[]
shareholders.peers.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
shareholders.peers.documents.name
string
shareholders.peers.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
shareholders.peers.documents.location
string
shareholders.peers.documents.verificationResponse
string
shareholders.peers.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
shareholders.peers.documents.metadata
object[]
shareholders.peers.documents.metadata.name
string
shareholders.peers.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
shareholders.peers.documents.metadata.value
string
shareholders.peers.SecretQuestion
object[]
shareholders.peers.SecretQuestion.question
string
shareholders.peers.SecretQuestion.answer
string
Response
200 - application/json
id
string
personFullname
string
peerFullname
string
escliationFullname
string
status
string
responsibility
string
positions
string
ownershipPercentage
string
person
object
person.firstName
object
person.firstName.name
string
person.firstName.order
integer
person.firstName.abbreviation
string
person.firstName.language
string
person.firstName.native
string
person.firstName.suffix
string
person.firstName.prefix
string
person.lastName
object
person.lastName.name
string
person.lastName.order
integer
person.lastName.abbreviation
string
person.lastName.language
string
person.lastName.native
string
person.lastName.suffix
string
person.lastName.prefix
string
person.fullName
string
person.groupId
string
person.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
person.dateOfBirth
string
person.placeOfBirth
string
person.nationality
string
person.pinCode
string
person.password
string
person.email
string
person.telephoneNumbers
object[]
person.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
person.telephoneNumbers.operator
string
person.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
person.telephoneNumbers.country
string
person.telephoneNumbers.number
string
person.telephoneNumbers.purpose
string
person.addresses
object[]
person.addresses.addressPurpose
string
person.addresses.address
object
person.addresses.address.country
string
person.addresses.address.area
string
person.addresses.address.zipCode
string
person.addresses.address.city
string
person.addresses.address.street
string
person.addresses.address.streetNumber
string[]
person.addresses.address.building
string
person.addresses.address.apartment
string
person.addresses.address.entrance
string
person.addresses.address.floor
string
person.addresses.address.doorNumber
string
person.addresses.address.geoPosition
object
person.addresses.address.geoPosition.latitude
number
person.addresses.address.geoPosition.longitude
number
person.addresses.address.geoPosition.altitude
number
person.addresses.address.alternative
object
person.addresses.address.alternative.word1
string
person.addresses.address.alternative.word2
string
person.addresses.address.alternative.word3
string
person.addresses.address.relatedToAddress
object[]
person.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
person.addresses.address.relatedToAddress.address
string
person.addresses.address.additionalData
object[]
person.addresses.address.additionalData.name
string
person.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
person.addresses.address.additionalData.value
string
person.documents
object[]
person.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
person.documents.name
string
person.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
person.documents.location
string
person.documents.verificationResponse
string
person.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
person.documents.metadata
object[]
person.documents.metadata.name
string
person.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
person.documents.metadata.value
string
person.SecretQuestion
object[]
person.SecretQuestion.question
string
person.SecretQuestion.answer
string
escallation
object
escallation.firstName
object
escallation.firstName.name
string
escallation.firstName.order
integer
escallation.firstName.abbreviation
string
escallation.firstName.language
string
escallation.firstName.native
string
escallation.firstName.suffix
string
escallation.firstName.prefix
string
escallation.lastName
object
escallation.lastName.name
string
escallation.lastName.order
integer
escallation.lastName.abbreviation
string
escallation.lastName.language
string
escallation.lastName.native
string
escallation.lastName.suffix
string
escallation.lastName.prefix
string
escallation.fullName
string
escallation.groupId
string
escallation.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
escallation.dateOfBirth
string
escallation.placeOfBirth
string
escallation.nationality
string
escallation.pinCode
string
escallation.password
string
escallation.email
string
escallation.telephoneNumbers
object[]
escallation.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
escallation.telephoneNumbers.operator
string
escallation.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
escallation.telephoneNumbers.country
string
escallation.telephoneNumbers.number
string
escallation.telephoneNumbers.purpose
string
escallation.addresses
object[]
escallation.addresses.addressPurpose
string
escallation.addresses.address
object
escallation.addresses.address.country
string
escallation.addresses.address.area
string
escallation.addresses.address.zipCode
string
escallation.addresses.address.city
string
escallation.addresses.address.street
string
escallation.addresses.address.streetNumber
string[]
escallation.addresses.address.building
string
escallation.addresses.address.apartment
string
escallation.addresses.address.entrance
string
escallation.addresses.address.floor
string
escallation.addresses.address.doorNumber
string
escallation.addresses.address.geoPosition
object
escallation.addresses.address.geoPosition.latitude
number
escallation.addresses.address.geoPosition.longitude
number
escallation.addresses.address.geoPosition.altitude
number
escallation.addresses.address.alternative
object
escallation.addresses.address.alternative.word1
string
escallation.addresses.address.alternative.word2
string
escallation.addresses.address.alternative.word3
string
escallation.addresses.address.relatedToAddress
object[]
escallation.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
escallation.addresses.address.relatedToAddress.address
string
escallation.addresses.address.additionalData
object[]
escallation.addresses.address.additionalData.name
string
escallation.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
escallation.addresses.address.additionalData.value
string
escallation.documents
object[]
escallation.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
escallation.documents.name
string
escallation.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
escallation.documents.location
string
escallation.documents.verificationResponse
string
escallation.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
escallation.documents.metadata
object[]
escallation.documents.metadata.name
string
escallation.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
escallation.documents.metadata.value
string
escallation.SecretQuestion
object[]
escallation.SecretQuestion.question
string
escallation.SecretQuestion.answer
string
peers
object
peers.firstName
object
peers.firstName.name
string
peers.firstName.order
integer
peers.firstName.abbreviation
string
peers.firstName.language
string
peers.firstName.native
string
peers.firstName.suffix
string
peers.firstName.prefix
string
peers.lastName
object
peers.lastName.name
string
peers.lastName.order
integer
peers.lastName.abbreviation
string
peers.lastName.language
string
peers.lastName.native
string
peers.lastName.suffix
string
peers.lastName.prefix
string
peers.fullName
string
peers.groupId
string
peers.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
peers.dateOfBirth
string
peers.placeOfBirth
string
peers.nationality
string
peers.pinCode
string
peers.password
string
peers.email
string
peers.telephoneNumbers
object[]
peers.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
peers.telephoneNumbers.operator
string
peers.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
peers.telephoneNumbers.country
string
peers.telephoneNumbers.number
string
peers.telephoneNumbers.purpose
string
peers.addresses
object[]
peers.addresses.addressPurpose
string
peers.addresses.address
object
peers.addresses.address.country
string
peers.addresses.address.area
string
peers.addresses.address.zipCode
string
peers.addresses.address.city
string
peers.addresses.address.street
string
peers.addresses.address.streetNumber
string[]
peers.addresses.address.building
string
peers.addresses.address.apartment
string
peers.addresses.address.entrance
string
peers.addresses.address.floor
string
peers.addresses.address.doorNumber
string
peers.addresses.address.geoPosition
object
peers.addresses.address.geoPosition.latitude
number
peers.addresses.address.geoPosition.longitude
number
peers.addresses.address.geoPosition.altitude
number
peers.addresses.address.alternative
object
peers.addresses.address.alternative.word1
string
peers.addresses.address.alternative.word2
string
peers.addresses.address.alternative.word3
string
peers.addresses.address.relatedToAddress
object[]
peers.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
peers.addresses.address.relatedToAddress.address
string
peers.addresses.address.additionalData
object[]
peers.addresses.address.additionalData.name
string
peers.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
peers.addresses.address.additionalData.value
string
peers.documents
object[]
peers.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
peers.documents.name
string
peers.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
peers.documents.location
string
peers.documents.verificationResponse
string
peers.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
peers.documents.metadata
object[]
peers.documents.metadata.name
string
peers.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
peers.documents.metadata.value
string
peers.SecretQuestion
object[]
peers.SecretQuestion.question
string
peers.SecretQuestion.answer
string