Organization
Get Organization By Customer Type
- 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
Get Organization By Customer Type
POST
/
organization
/
getByCustomerType
/
{customerType}
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
customerType
array
*
customerType
Required
array
Document Purpose
object
type
string
type
string
created
string
created
string
status
string
status
string
pageNumber
integer
pageNumber
integer
pageSize
integer
pageSize
integer
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
customerType
enum<string>[]
requiredDocument Purpose
Available options:
Employee
, Shareholder
, Customer
Body
application/json
type
string
created
string
status
string
pageNumber
integer
pageSize
integer
Response
200 - application/json
tenantId
string
organizations
object[]
organizations.countryOfCorporation
string
organizations.legalName
string
organizations.isTradingNameExist
boolean
default: falseorganizations.tradingName
string
organizations.taxRegistrationNumber
string
organizations.taxIdentificationNumber
string
organizations.dateOfIncorporation
string
organizations.businesstypes
string
organizations.sourceOfIncomingFund
string
organizations.purposeOfAccount
string
organizations.expectedAnnualActivityOfPlatform
string
organizations.registrationNumber
string
organizations.businessType
enum<string>
Available options:
Partner
, Supplier
organizations.shareholders
object[]
organizations.shareholders.id
string
organizations.shareholders.personFullname
string
organizations.shareholders.peerFullname
string
organizations.shareholders.escliationFullname
string
organizations.shareholders.status
string
organizations.shareholders.responsibility
string
organizations.shareholders.positions
string
organizations.shareholders.ownershipPercentage
string
organizations.shareholders.person
object
organizations.shareholders.person.firstName
object
organizations.shareholders.person.firstName.name
string
organizations.shareholders.person.firstName.order
integer
organizations.shareholders.person.firstName.abbreviation
string
organizations.shareholders.person.firstName.language
string
organizations.shareholders.person.firstName.native
string
organizations.shareholders.person.firstName.suffix
string
organizations.shareholders.person.firstName.prefix
string
organizations.shareholders.person.lastName
object
organizations.shareholders.person.lastName.name
string
organizations.shareholders.person.lastName.order
integer
organizations.shareholders.person.lastName.abbreviation
string
organizations.shareholders.person.lastName.language
string
organizations.shareholders.person.lastName.native
string
organizations.shareholders.person.lastName.suffix
string
organizations.shareholders.person.lastName.prefix
string
organizations.shareholders.person.fullName
string
organizations.shareholders.person.groupId
string
organizations.shareholders.person.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
organizations.shareholders.person.dateOfBirth
string
organizations.shareholders.person.placeOfBirth
string
organizations.shareholders.person.nationality
string
organizations.shareholders.person.pinCode
string
organizations.shareholders.person.password
string
organizations.shareholders.person.email
string
organizations.shareholders.person.telephoneNumbers
object[]
organizations.shareholders.person.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
organizations.shareholders.person.telephoneNumbers.operator
string
organizations.shareholders.person.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
organizations.shareholders.person.telephoneNumbers.country
string
organizations.shareholders.person.telephoneNumbers.number
string
organizations.shareholders.person.telephoneNumbers.purpose
string
organizations.shareholders.person.addresses
object[]
organizations.shareholders.person.addresses.addressPurpose
string
organizations.shareholders.person.addresses.address
object
organizations.shareholders.person.addresses.address.country
string
organizations.shareholders.person.addresses.address.area
string
organizations.shareholders.person.addresses.address.zipCode
string
organizations.shareholders.person.addresses.address.city
string
organizations.shareholders.person.addresses.address.street
string
organizations.shareholders.person.addresses.address.streetNumber
string[]
organizations.shareholders.person.addresses.address.building
string
organizations.shareholders.person.addresses.address.apartment
string
organizations.shareholders.person.addresses.address.entrance
string
organizations.shareholders.person.addresses.address.floor
string
organizations.shareholders.person.addresses.address.doorNumber
string
organizations.shareholders.person.addresses.address.geoPosition
object
organizations.shareholders.person.addresses.address.geoPosition.latitude
number
organizations.shareholders.person.addresses.address.geoPosition.longitude
number
organizations.shareholders.person.addresses.address.geoPosition.altitude
number
organizations.shareholders.person.addresses.address.alternative
object
organizations.shareholders.person.addresses.address.alternative.word1
string
organizations.shareholders.person.addresses.address.alternative.word2
string
organizations.shareholders.person.addresses.address.alternative.word3
string
organizations.shareholders.person.addresses.address.relatedToAddress
object[]
organizations.shareholders.person.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
organizations.shareholders.person.addresses.address.relatedToAddress.address
string
organizations.shareholders.person.addresses.address.additionalData
object[]
organizations.shareholders.person.addresses.address.additionalData.name
string
organizations.shareholders.person.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.shareholders.person.addresses.address.additionalData.value
string
organizations.shareholders.person.documents
object[]
organizations.shareholders.person.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
organizations.shareholders.person.documents.name
string
organizations.shareholders.person.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
organizations.shareholders.person.documents.location
string
organizations.shareholders.person.documents.verificationResponse
string
organizations.shareholders.person.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
organizations.shareholders.person.documents.metadata
object[]
organizations.shareholders.person.documents.metadata.name
string
organizations.shareholders.person.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.shareholders.person.documents.metadata.value
string
organizations.shareholders.person.SecretQuestion
object[]
organizations.shareholders.person.SecretQuestion.question
string
organizations.shareholders.person.SecretQuestion.answer
string
organizations.shareholders.escallation
object
organizations.shareholders.escallation.firstName
object
organizations.shareholders.escallation.firstName.name
string
organizations.shareholders.escallation.firstName.order
integer
organizations.shareholders.escallation.firstName.abbreviation
string
organizations.shareholders.escallation.firstName.language
string
organizations.shareholders.escallation.firstName.native
string
organizations.shareholders.escallation.firstName.suffix
string
organizations.shareholders.escallation.firstName.prefix
string
organizations.shareholders.escallation.lastName
object
organizations.shareholders.escallation.lastName.name
string
organizations.shareholders.escallation.lastName.order
integer
organizations.shareholders.escallation.lastName.abbreviation
string
organizations.shareholders.escallation.lastName.language
string
organizations.shareholders.escallation.lastName.native
string
organizations.shareholders.escallation.lastName.suffix
string
organizations.shareholders.escallation.lastName.prefix
string
organizations.shareholders.escallation.fullName
string
organizations.shareholders.escallation.groupId
string
organizations.shareholders.escallation.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
organizations.shareholders.escallation.dateOfBirth
string
organizations.shareholders.escallation.placeOfBirth
string
organizations.shareholders.escallation.nationality
string
organizations.shareholders.escallation.pinCode
string
organizations.shareholders.escallation.password
string
organizations.shareholders.escallation.email
string
organizations.shareholders.escallation.telephoneNumbers
object[]
organizations.shareholders.escallation.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
organizations.shareholders.escallation.telephoneNumbers.operator
string
organizations.shareholders.escallation.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
organizations.shareholders.escallation.telephoneNumbers.country
string
organizations.shareholders.escallation.telephoneNumbers.number
string
organizations.shareholders.escallation.telephoneNumbers.purpose
string
organizations.shareholders.escallation.addresses
object[]
organizations.shareholders.escallation.addresses.addressPurpose
string
organizations.shareholders.escallation.addresses.address
object
organizations.shareholders.escallation.addresses.address.country
string
organizations.shareholders.escallation.addresses.address.area
string
organizations.shareholders.escallation.addresses.address.zipCode
string
organizations.shareholders.escallation.addresses.address.city
string
organizations.shareholders.escallation.addresses.address.street
string
organizations.shareholders.escallation.addresses.address.streetNumber
string[]
organizations.shareholders.escallation.addresses.address.building
string
organizations.shareholders.escallation.addresses.address.apartment
string
organizations.shareholders.escallation.addresses.address.entrance
string
organizations.shareholders.escallation.addresses.address.floor
string
organizations.shareholders.escallation.addresses.address.doorNumber
string
organizations.shareholders.escallation.addresses.address.geoPosition
object
organizations.shareholders.escallation.addresses.address.geoPosition.latitude
number
organizations.shareholders.escallation.addresses.address.geoPosition.longitude
number
organizations.shareholders.escallation.addresses.address.geoPosition.altitude
number
organizations.shareholders.escallation.addresses.address.alternative
object
organizations.shareholders.escallation.addresses.address.alternative.word1
string
organizations.shareholders.escallation.addresses.address.alternative.word2
string
organizations.shareholders.escallation.addresses.address.alternative.word3
string
organizations.shareholders.escallation.addresses.address.relatedToAddress
object[]
organizations.shareholders.escallation.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
organizations.shareholders.escallation.addresses.address.relatedToAddress.address
string
organizations.shareholders.escallation.addresses.address.additionalData
object[]
organizations.shareholders.escallation.addresses.address.additionalData.name
string
organizations.shareholders.escallation.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.shareholders.escallation.addresses.address.additionalData.value
string
organizations.shareholders.escallation.documents
object[]
organizations.shareholders.escallation.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
organizations.shareholders.escallation.documents.name
string
organizations.shareholders.escallation.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
organizations.shareholders.escallation.documents.location
string
organizations.shareholders.escallation.documents.verificationResponse
string
organizations.shareholders.escallation.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
organizations.shareholders.escallation.documents.metadata
object[]
organizations.shareholders.escallation.documents.metadata.name
string
organizations.shareholders.escallation.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.shareholders.escallation.documents.metadata.value
string
organizations.shareholders.escallation.SecretQuestion
object[]
organizations.shareholders.escallation.SecretQuestion.question
string
organizations.shareholders.escallation.SecretQuestion.answer
string
organizations.shareholders.peers
object
organizations.shareholders.peers.firstName
object
organizations.shareholders.peers.firstName.name
string
organizations.shareholders.peers.firstName.order
integer
organizations.shareholders.peers.firstName.abbreviation
string
organizations.shareholders.peers.firstName.language
string
organizations.shareholders.peers.firstName.native
string
organizations.shareholders.peers.firstName.suffix
string
organizations.shareholders.peers.firstName.prefix
string
organizations.shareholders.peers.lastName
object
organizations.shareholders.peers.lastName.name
string
organizations.shareholders.peers.lastName.order
integer
organizations.shareholders.peers.lastName.abbreviation
string
organizations.shareholders.peers.lastName.language
string
organizations.shareholders.peers.lastName.native
string
organizations.shareholders.peers.lastName.suffix
string
organizations.shareholders.peers.lastName.prefix
string
organizations.shareholders.peers.fullName
string
organizations.shareholders.peers.groupId
string
organizations.shareholders.peers.gender
enum<string>
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
organizations.shareholders.peers.dateOfBirth
string
organizations.shareholders.peers.placeOfBirth
string
organizations.shareholders.peers.nationality
string
organizations.shareholders.peers.pinCode
string
organizations.shareholders.peers.password
string
organizations.shareholders.peers.email
string
organizations.shareholders.peers.telephoneNumbers
object[]
organizations.shareholders.peers.telephoneNumbers.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
organizations.shareholders.peers.telephoneNumbers.operator
string
organizations.shareholders.peers.telephoneNumbers.encoding
enum<string>
Available options:
numbers
, international
, text
organizations.shareholders.peers.telephoneNumbers.country
string
organizations.shareholders.peers.telephoneNumbers.number
string
organizations.shareholders.peers.telephoneNumbers.purpose
string
organizations.shareholders.peers.addresses
object[]
organizations.shareholders.peers.addresses.addressPurpose
string
organizations.shareholders.peers.addresses.address
object
organizations.shareholders.peers.addresses.address.country
string
organizations.shareholders.peers.addresses.address.area
string
organizations.shareholders.peers.addresses.address.zipCode
string
organizations.shareholders.peers.addresses.address.city
string
organizations.shareholders.peers.addresses.address.street
string
organizations.shareholders.peers.addresses.address.streetNumber
string[]
organizations.shareholders.peers.addresses.address.building
string
organizations.shareholders.peers.addresses.address.apartment
string
organizations.shareholders.peers.addresses.address.entrance
string
organizations.shareholders.peers.addresses.address.floor
string
organizations.shareholders.peers.addresses.address.doorNumber
string
organizations.shareholders.peers.addresses.address.geoPosition
object
organizations.shareholders.peers.addresses.address.geoPosition.latitude
number
organizations.shareholders.peers.addresses.address.geoPosition.longitude
number
organizations.shareholders.peers.addresses.address.geoPosition.altitude
number
organizations.shareholders.peers.addresses.address.alternative
object
organizations.shareholders.peers.addresses.address.alternative.word1
string
organizations.shareholders.peers.addresses.address.alternative.word2
string
organizations.shareholders.peers.addresses.address.alternative.word3
string
organizations.shareholders.peers.addresses.address.relatedToAddress
object[]
organizations.shareholders.peers.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
organizations.shareholders.peers.addresses.address.relatedToAddress.address
string
organizations.shareholders.peers.addresses.address.additionalData
object[]
organizations.shareholders.peers.addresses.address.additionalData.name
string
organizations.shareholders.peers.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.shareholders.peers.addresses.address.additionalData.value
string
organizations.shareholders.peers.documents
object[]
organizations.shareholders.peers.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
organizations.shareholders.peers.documents.name
string
organizations.shareholders.peers.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
organizations.shareholders.peers.documents.location
string
organizations.shareholders.peers.documents.verificationResponse
string
organizations.shareholders.peers.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
organizations.shareholders.peers.documents.metadata
object[]
organizations.shareholders.peers.documents.metadata.name
string
organizations.shareholders.peers.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.shareholders.peers.documents.metadata.value
string
organizations.shareholders.peers.SecretQuestion
object[]
organizations.shareholders.peers.SecretQuestion.question
string
organizations.shareholders.peers.SecretQuestion.answer
string
organizations.relatedTo
object
organizations.relatedTo.relationType
string
organizations.relatedTo.organizationID
string
organizations.website
string
organizations.businessSector
string
organizations.rangeOfServicesOrGoods
string
organizations.transactionPredict
object
organizations.transactionPredict.MonthlyVolumeRange
number
organizations.transactionPredict.NumberOfMonthlyPayment
number
organizations.transactionPredict.MaxSinglePayment
number
organizations.countryList
object
organizations.countryList.SendList
string[]
organizations.countryList.ReceiveList
string[]
organizations.telephoneNumber
object[]
organizations.telephoneNumber.phoneType
enum<string>
Available options:
fixed
, mobile
, satellite
, virtual
organizations.telephoneNumber.operator
string
organizations.telephoneNumber.encoding
enum<string>
Available options:
numbers
, international
, text
organizations.telephoneNumber.country
string
organizations.telephoneNumber.number
string
organizations.telephoneNumber.purpose
string
organizations.addresses
object[]
organizations.addresses.addressPurpose
string
organizations.addresses.address
object
organizations.addresses.address.country
string
organizations.addresses.address.area
string
organizations.addresses.address.zipCode
string
organizations.addresses.address.city
string
organizations.addresses.address.street
string
organizations.addresses.address.streetNumber
string[]
organizations.addresses.address.building
string
organizations.addresses.address.apartment
string
organizations.addresses.address.entrance
string
organizations.addresses.address.floor
string
organizations.addresses.address.doorNumber
string
organizations.addresses.address.geoPosition
object
organizations.addresses.address.geoPosition.latitude
number
organizations.addresses.address.geoPosition.longitude
number
organizations.addresses.address.geoPosition.altitude
number
organizations.addresses.address.alternative
object
organizations.addresses.address.alternative.word1
string
organizations.addresses.address.alternative.word2
string
organizations.addresses.address.alternative.word3
string
organizations.addresses.address.relatedToAddress
object[]
organizations.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by
, crossing
, opposite_to
, inside_of
, behind
, infront
organizations.addresses.address.relatedToAddress.address
string
organizations.addresses.address.additionalData
object[]
organizations.addresses.address.additionalData.name
string
organizations.addresses.address.additionalData.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.addresses.address.additionalData.value
string
organizations.documents
object[]
organizations.documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
organizations.documents.name
string
organizations.documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
organizations.documents.location
string
organizations.documents.verificationResponse
string
organizations.documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
organizations.documents.metadata
object[]
organizations.documents.metadata.name
string
organizations.documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
organizations.documents.metadata.value
string
organizations.businessToBusinessMap
object[]
organizations.businessToBusinessMap.relationType
enum<string>
Available options:
Partner
, Supplier
organizations.businessToBusinessMap.tenannaId
string
organizations.businessToBusinessMap.organizationId
string
organizations.businessToBusinessMap.RelatingorganizationId
string
organizations.businessToCustomerMap
object[]
organizations.businessToCustomerMap.relationType
enum<string>
Available options:
Employee
, Shareholder
, Customer
organizations.businessToCustomerMap.tenannaId
string
organizations.businessToCustomerMap.personid
string
organizations.businessToCustomerMap.organizationId
string
pagination
object
pagination.numberOfPage
integer
pagination.totalSize
integer
pagination.currentPage
integer