For AI agents: visit https://docs.xpollens.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Xpollens DevelopersXpollens DevelopersHome
HomeGuidesAPI ReferenceRelease noteChangelogStatus page
HomeLog InXpollens Developers
API Reference
Log In
HomeGuidesAPI ReferenceRelease noteChangelogStatus page

INTRODUCTION

  • API Overview
  • API Authentication
  • API Rate limitation

USERS

  • BusinessEntity
    • /api/v4.0/business-entitiesget
    • /api/v4.0/business-entities/{businessEntityId}get
  • Professionals
    • PortalLink
      • Creates a portal linkpost
  • Individuals
    • User
      • Get usersget
      • Create a userpost
      • Update a userput
      • Update beneficial owner declarativepatch
      • Save user cgupost
      • Update user declarativeput
      • Save user declarativepost
      • Get user declarativeget
  • LegalEntity
    • IndividualEntrepreneur
      • search individual entrepreneurs entitiesget
      • Create an individual entrepreneurpost
      • Update an individual entrepreneurput
    • Get legal entitiesget
    • Create a legal entitypost
    • Update a legal entityput
  • User Experience
    • Generate new QR codepost
    • StrongAuthenticationRequest Generic Endpointpost
  • PeriodicReview
    • Simulate periodic reviewpost
    • Complete periodic reviewpost

ONBOARDING

  • Individual and Professional KYC
    • Kyc
      • Upload a Kyc diligencepost
      • Get a Kyc diligenceget
      • Update a Kyc demandpatch
      • Create a Kyc demandpost
      • Get a Kyc demandget
      • Save third party introduction diligence.post
    • FATCA-CRS Tax information
      • TIN - Recover format references for FATCA-CRSget
      • TIN - Recover version of the last format referenceget
      • Updates FATCA/CRS informationpatch
      • Upload a FATCA-EAI diligencepost
      • Get a FATCA-EAI diligenceget
      • Get FATCA/CRS informationget
      • Get self-certification informationget
      • Download self-certification in PDFget
      • Sign self-certificationpost
      • Reject self-certificationpost
      • Revoke self-certificationpost
    • Retrieve PEP information and AML analysis statusget
    • Income
      • Upload an Income diligencepost
      • Get an Income diligenceget
      • Get a Income demandget
    • Cgu

ACCOUNTS

  • Account Management
    • Get an accountget
    • Account Additional Balances
      • Modify account additional balanceput
      • Get the additional balance of an accountget
    • Create an additional account for an account holderpost
    • Get an account holder's list of accountsget
    • Create an account closure requestpost
    • Get a closure requestget
    • Account Limits
      • Get account limitsget
      • Modify account limitspatch
    • Account Debt
      • Modify a debtpatch
      • Get a debt by a debt public Idget
      • Get a partial list of debtsget
      • Get the debt balance of an accountget
  • Operations and Transactions
    • Get transactions for an accountget
    • Get partner account operationsget
  • Statements
    • Get a bank statement by a bank statement identifierget
    • Get a list of bank statementsget
  • Virtual IBAN
    • Create a virtual ibanpost
    • Get a virtual ibanget
    • Get a virtual iban's list of an accountget
    • Revoke a virtual ibandel

CARDS

  • Physical Cards Ordering
    • Create a physical cardpost
    • Get card order detailsget
    • Remanufacture a card from an existing cardpost
    • Renew cardpost
    • Grouped Ordering
      • Fetch all delivery points based on selected criteriaget
      • Publish grouped shipment card orders.post
      • Get delivery point detailsget
    • Stock Ordering
      • Assign a cardpatch
      • Download the cards created in a cards stock orderget
  • Virtual Cards Creation
    • Create a virtual cardpost
  • Cards Management
    • Get card detailsget
    • Get list of cards by criteriaget
    • Get all cards by holderget
    • Get card limitsget
    • Update a limit for a cardput
    • Update card selfcare optionsput
    • Add one or more limits to a card only for Unit.post
    • Delete a limit applied to a card.del
    • Update card selfcare optionspatch
    • Get PINget
    • Get CVX2, PAN and Expiry date of a cardget
    • Activate a cardpost
    • Oppose a cardpost
    • Get the token signatureget
    • Oppose a cardpatch
    • Cancel a cardpost
  • Card Operations
    • Retrieve a specific card operationget
    • Get list of card operations by criteriaget
    • Retrieve a specific card dispute operationget
    • card-authorization-filters
      • Get all card authorization filters for a specific card offerget
      • Get a card authorization filter by IDget
  • Card tokenization
    • Get Token Detailsget
    • Get all tokens by cardget
    • In-App Verification Activationpost
    • Create an Apple provisioning payload for a cardpost
    • Apple Wallet Extension
    • Google OPCpost

PAYIN

  • SEPA Direct Debit
    • Create SDD Outpost
    • Get SDD by Idget
    • Get SDD Listget
    • Refund SDD Inpost
  • TOPUP
    • Topup
      • Create a top uppost
      • Get top up by orderIdget
      • Get all top upget
      • Refund a top uppost
      • Get chargebackget
      • Simulate a chargebackpost
    • CardTopup
      • Get a registered bank cardget
      • Get all registered banks cardsget
      • Delete a registered bank carddel

INTERNAL TRANSFERS

  • Internal transfer
    • Create an internal transferpost
    • Get a internal transferget
    • Get Transfer List for an user or a partnerget
  • Debt transfer
    • Get an internal debt transferget

PayOut

  • Payees
    • Create a beneficiarypost
    • Modify a beneficiaryput
    • Delete a beneficiarydel
    • Get beneficiary by Idget
    • Retrieve Beneficiaryget
  • SEPA Credit Transfer
    • Create SCT Outpost
    • Get SCT Listget
    • Get SCT by Idget
  • SEPA Instant Payment
    • Create an Instant Paymentpost
    • Get Instant Payment by sepaInstantPaymentIdget
    • Get Instant Payment Listget
    • Check if a bank is reachable via Instant Paymentget

Verification of Payee

  • Request Verification Of Payeepost
  • Approve
    • Approve pending SCT after VoPpost
    • Approve pending IP after VoPpost
  • Cancel
    • Cancel pending SCT after VoPpost
    • Cancel pending IP after VoPpost

Mandates

  • Mandates
    • Create Mandatepost
    • Activate Mandatepost
    • Authorize Mandatepost
    • Block Mandatepost
    • Get Mandate Listget
    • Get Mandateget
    • Revoke a mandatedel

SIMULTATION API

  • SepaCreditTransfer
    • Create Simulated SCT Inpost
    • Simulate Return on SCT Inpost
    • Create simulated SCT Outpost
    • Simulate Return on SCT Outpost
  • SepaDirectDebit
    • Create Simulated SDD Inpost
    • Simulate Cancel on SDD Inpost
    • Simulate Return on SDD Inpost
    • Create Simulated SDD Outpost
    • Simulate Reject on SDD Outpost
    • Simulate Return on SDD Outpost
  • CardOperations
    • Simulate offline settlementpost
    • Simulate posting an authorization messagepost
    • Simulate settlementpost
    • Simulate original credit transfertpost
    • Simulate authorization paymentpost
    • Simulate authorizationpost
    • Simulate card disputepost
    • Simulate authorization withdrawalpost
  • InstantPayment
    • Simulate Instant payment Inpost
    • Simulate recall Instant payment Inpost

CALLBACKS

  • Introduction to Webhooks
  • Webhook Manager
    • /api/v2.0/webhooksget
  • Callbacks List
    • #01 - Topupwebhook
    • #04 - KYC demand - Version 2.0post
    • #05 - Bank card registrationwebhook
    • #18 - SDD Outpost
    • #19 - SDD Inpost
    • #31 - KYC complementary diligencepost
    • #32 - Risk levelpost
    • #35 - Strong authentication enrollmentwebhook
    • #36 - Strong authenticationwebhook
    • #37 - Topup refundwebhook
    • #43 - Legal entitywebhook
    • #44 - Fatca-EAIpost
    • #45 - Account statuspost
    • #46 - KYB demandpost
    • #47 - Re-upload of diligencespost
    • #48 - Webview URLpost
    • DemandChangedwebhook
    • BankStatementCreatedpost
    • BatchCardOrderCompletedwebhook
    • BusinessEntityCreatedOrUpdatedwebhook
    • CardAuthorizationFilterCreatedOrUpdatedwebhook
    • CardCreatedOrUpdatedwebhook
    • CardDisputeCreatedOrUpdatedwebhook
    • CardOrderCreatedOrUpdatedwebhook
    • CardTokenCreatedOrUpdatedwebhook
    • CardTokenOtpCreatedwebhook
    • CardOperationCreatedOrUpdatedwebhook
    • ChargebackCompletedwebhook
    • ClosureRequestCreatedOrUpdatedpost
    • DebtCreatedOrUpdatedpost
    • SeizureCreatedOrUpdatedpost
    • DeliveryPointCreatedOrUpdatedwebhook
    • FatcaCrsCreatedOrUpdatedwebhook
    • FatcaCrsSelfCertificationCreatedOrUpdatedwebhook
    • FatcaCrsAttachmentCreatedOrUpdatedwebhook
    • Income demand status changedwebhook
    • IndividualEntrepreneurCreatedOrUpdatedwebhook
    • InstantPaymentCreatedOrUpdatedpost
    • InternalDebtTransferCreatedpost
    • InternalTransferpost
    • MandateCreatedOrUpdatedpost
    • PeriodicReviewChangedwebhook
    • Politically Exposed Person Status Created Or Updatedpost
    • PortalLinkCreatedOrUpdatedwebhook
    • SepaCreditTransferCreatedOrUpdatedpost
    • SepaDirectDebitCreatedOrUpdatedpost
    • StrongAuthenticationRequestCreatedOrUpdatedwebhook
    • TinFormatsUpdatedpost
    • UserCreatedOrUpdatedwebhook
    • VirtualIbanCreatedOrUpdatedpost

FORMER API VERSION

  • Version V2.x
    • Kyc
      • Generate new QR codepost
      • Upload a Kyc diligencepost
      • Get a Kyc diligenceget
      • Get a Kyc demandget
      • create a kyc demand for appUserIdpost
      • Get demand web view urlget
    • Account Management
      • Create an account closure requestpost
      • GET a closure requestget
      • Get an accountget
    • Kyc
      • FatcaEai
      • Create and update FATCA information for a Customerpatch
      • Get all the customer compliance informationsget
    • Bank Statement
      • Get an Account Bank Statementget
      • Get a list of available account statements for an accountget
    • Cards Creation
      • Create a cardpost
      • Remanufacture a card from an existing cardpost
      • Assign a holder to a card.patch
      • Activate a cardpatch
      • Cancel a cardpatch
      • Get card detailsget
      • Get all cards by partnerget
    • OfferPartner
      • Get all cards by offerPartnerget
    • SEPA Instant Payment
      • Get Ref Bip.get
      • Initiate SEPA instant credit transferpost
      • Get SEPA instant credit transfers filter by dateget
      • Get SEPA instant credit transfer by orderIdget
    • Virtual IBAN
      • Create a new virtual ibanpost
      • Get virtual ibanget
  • Version V1.X
    • CardOperations
      • Retrieve card operation detailget
      • Retrieve card authorization detailget
      • Retrieve all card operations by UserIdget
    • SEPA Direct Debit
      • Create Direct Debitspost
      • Get SDD Listget
      • Get Sdd by OrderIdget
    • Account Management V1.1
      • Update account limitsput
      • Get an additional balanceget
      • Modify an additional balanceput
      • Modify a debt remaining amountput
      • Get account limitsget
      • Modify a debt recovery statusput
      • Get a debt by a debt public Idget
      • Get a partial list of debtsget
    • Beneficiary Management
      • Get bank account by Idget
      • Create a bank accountpost
      • Modify a bank accountput
      • Get list of bank accounts per operation typeget
    • Create User
      • Create a userpost
      • Modify user informationput
      • get user informationget
      • get user informationget
    • Internal Transfer
      • Create a P2P transferpost
      • Get P2P Transfer List for an user or a partner. The first 500 are returned.get
      • Get a P2P transferget
    • SEPA Credit Transfer
      • Create SCT Outpost
      • Get SCT by order IDget
      • Consult SCT Operations List of Userget
    • SEPA Direct Debit Mandate
      • Create Mandatepost
      • Activate Mandateput
      • Get a Mandateget
  • FATCA EAI (former)
    • Create or update FATCA-EAI information for a userpatch
    • Retrieve FATCA-EAI information and follow FATCA-EAI analysis statusget
    • Get the FATCA self-certification in pdf for a given customer.get
  • Former Call Backs
    • #01 - Topup - DEPRECATEDpost
    • #01 - Topup - DEPRECATEDpost
    • #04 - KYC demand - DEPRECATEDpost
    • #05 - Bank card registration - DEPRECATEDpost
    • #15 - User freezepost
    • #16 - SCT Inpost
    • #17 - SCT Outpost
    • #20 - Card operationpost
    • #21 - Card creation/statuspost
    • #24 - Card clearing processingpost
    • #25 - Token lifecycle managementpost
    • #29 - P2P transferpost
    • #33 - Client debtpost
    • #34 - User onboardingpost
    • #38 - Instant payment Inpost
    • #39 - Instant payment Outpost
    • #41 - RecallInstantPaymentInpost
    • #40 - Fund reservationpost
    • #42 - RecallInstantPaymentOutpost

kyc v3.0

  • BankAccountOwnership
    • Get a Bank Account Ownership demandget
  • Demand
    • /api/v3.0/internal/{partnerCode}/users/{appUserId}/demand/diligences/{diligencePublicId}patch
  • Fatca
    • Get Kyc demandget
  • Kyc
    • Update a Kyc Diligencepatch
    • Update a Kyc Demand Decisionpatch
    • Synchronize a Kyc demandpatch
    • Get demand web view urlget
    • Generate new QR codepost

Webhook - DemandChanged

  • Demand

Cgu

Updated over 1 year ago


Get a Income demand
Account Management
Did this page help you?

Updated over 1 year ago


Get a Income demand
Account Management
Did this page help you?
Copyright © 2025 Xpollens All rights reserved
Legal Statement
Data Protection
Cookie policy
Contact