{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/product-catalog/BankMatch/sidebars.yaml","current-catalog-info":"current-catalog-info-/connect-apis-catalog/product-catalog/bankmatch/bankmatch"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"IBAN Person Endpoints","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"iban-person-endpoints","__idx":0},"children":["IBAN Person Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The IBAN Person endpoints in the Bank Match API allow you to verify and match personal bank account details using the IBAN format. These endpoints support compliance, fraud prevention, and onboarding processes for individuals."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["IBAN Person Search is currently available for France only."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below is a flow diagram guide on how to use these endpoints effectively."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"flow-diagram","__idx":1},"children":["Flow Diagram"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"%%{ init: { \"theme\": \"default\" } }%%\nflowchart TB\n A[Authenticate]\n B[Retrieve IBAN Person Search Criteria]\n C[Run IBAN Person Search]\n D[Review Search Results]\n E[Review Search History]\n\n A --> B --> C --> D --> E\n","diagramHtml":"

Authenticate

Retrieve IBAN Person Search Criteria

Run IBAN Person Search

Review Search Results

Review Search History

","diagramHtmlDark":"

Authenticate

Retrieve IBAN Person Search Criteria

Run IBAN Person Search

Review Search Results

Review Search History

"},"children":["%%{ init: { \"theme\": \"default\" } }%%\nflowchart TB\n A[Authenticate]\n B[Retrieve IBAN Person Search Criteria]\n C[Run IBAN Person Search]\n D[Review Search Results]\n E[Review Search History]\n\n A --> B --> C --> D --> E\n"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Diagram summary (accessibility): Authenticate first, then retrieve IBAN person search criteria, run the IBAN person search, review the returned match results and, if needed, review your previous searches in the search history."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-authenticate","__idx":2},"children":["1. Authenticate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before using any of the endpoints, you must authenticate. This ensures you have the necessary permissions to access the data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/bankmatch/bankmatch/authentication/authenticate"},"children":["View endpoint documentation"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":3},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /authenticate\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-retrieve-iban-person-search-criteria","__idx":4},"children":["2. Retrieve IBAN Person Search Criteria"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint returns the supported languages and search criteria for IBAN person searches in the requested bank country, including the IBAN validation rules."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/bankmatch/bankmatch/person-search/compliancegetbankmatchibanpersonsearchcriteria"},"children":["View endpoint documentation"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":5},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /compliance/bankMatch/IBAN/person/searchCriteria?bankCountry=FR\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-iban-person-search","__idx":6},"children":["3. IBAN Person Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to search and match personal bank account details using the IBAN format. Search details are passed as query parameters. Use the search criteria from step 2 to confirm which details are supported."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/bankmatch/bankmatch/person-search/compliancegetbankmatchibanpersonsearch"},"children":["View endpoint documentation"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankCountry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO Alpha-2 country code used to specify the country for person bank matching criteria."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name of the person."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last name of the person."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["birthDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Birth date of the person in the format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DD/MM/YYYY"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iban"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["International Bank Account Number (IBAN)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response language. Use the search criteria endpoint to confirm available languages. Unsupported languages default to English (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EN"]},")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-2","__idx":7},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /compliance/bankMatch/IBAN/person?bankCountry=FR&firstName={firstName}&lastName={lastName}&birthDate=28/04/1978&iban={iban}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-review-search-results","__idx":8},"children":["4. Review Search Results"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After submitting an IBAN person search, review the response to determine if the bank account details have been successfully matched."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]}]},": The search has completed. The response contains the result of the match."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]},": The bank details are still being verified. The response contains a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]},", a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["checkId"]}," and a message describing the request."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful response includes the following fields:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier for the bank match search."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status of the search process, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["classification"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Classification result of the search."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reasons"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of reason codes for the result."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reasonLabels"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Labels describing each reason code."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment identity associated with the IBAN and, where returned, the account holder's representative details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["input"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment identity and person details you supplied."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sepamailVerificationStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status of the SepaMail verification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastMatchVerificationDetail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status, date and any additional data from the last match verification."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Compare ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["input"]}," and use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reasons"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reasonLabels"]}," to understand why the account was, or was not, matched."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-review-search-history","__idx":9},"children":["5. Review Search History"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to return a paginated list of previous IBAN person searches made by your account, including each search's result: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MATCH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NO_MATCH"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/product-catalog/bankmatch/bankmatch/person-search/compliancebankmatchibanpersonhistoryget"},"children":["View endpoint documentation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can filter the list by date range (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}," format), result (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]},"), your reference (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]},") and user (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]},"). Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," (maximum ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},") to page through results."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-3","__idx":10},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /compliance/bankMatch/IBAN/person/history?startDate=2026-01-01&endDate=2026-01-31&page=1&pageSize=20\n","lang":"http"},"children":[]}]},"headings":[{"value":"IBAN Person Endpoints","id":"iban-person-endpoints","depth":1},{"value":"Flow Diagram","id":"flow-diagram","depth":2},{"value":"1. Authenticate","id":"1-authenticate","depth":2},{"value":"Example Request","id":"example-request","depth":3},{"value":"2. Retrieve IBAN Person Search Criteria","id":"2-retrieve-iban-person-search-criteria","depth":2},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"3. IBAN Person Search","id":"3-iban-person-search","depth":2},{"value":"Example Request","id":"example-request-2","depth":3},{"value":"4. Review Search Results","id":"4-review-search-results","depth":2},{"value":"5. Review Search History","id":"5-review-search-history","depth":2},{"value":"Example Request","id":"example-request-3","depth":3}],"frontmatter":{"seo":{"title":"IBAN Person Endpoints"}},"lastModified":"2026-10-07T07:27:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/product-catalog/bankmatch/documentation/person","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}