{"openapi":"3.1.0","info":{"title":"Verification of Payee","description":"Automate payments across banks with a single API","version":"1","contact":{"name":"API Support","email":"dev@numeral.io"}},"tags":[{"name":"payee-verification-requests","description":"Payee verification requests endpoints"},{"name":"verification-scheme-participants","description":"Verification scheme participants endpoints"}],"servers":[{"url":"https://sandbox.numeral.io/v1"}],"components":{"securitySchemes":{"sec0":{"type":"apiKey","in":"header","name":"x-api-key"}},"parameters":{"vop_request.create_parameters.idempotency_key":{"name":"Idempotency-Key","in":"header","description":"An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.","schema":{"type":"string","example":"8A2gcC"}}},"responses":{"errors.400.validation":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.404.not_found":{"description":"The specified resource was not found."},"errors.409.conflict":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.415.unsupported_media_type":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.500.internal_server_error":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"type":"object","properties":{"error":{"type":"string","example":"validation_error"},"message":{"type":"string","example":"validation errors occurred while processing request"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}},"correlation_id":{"type":"string","format":"uuid"}}},"common.metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"false"}},"vop_request.payee_identification_type":{"type":"string","enum":["name","inac","legal_entity_identifier","business_identification_code","bank_identification","central_bank_identification","clearing_house_identification","company_incorporation_number","company_identification","customer_number","duns_number","employee_number","global_location_number","siren","siret","tax_number","business_domain_identification","other_identification","proprietary_code"],"description":"The type of identification used in the request. See Supported identification type for more information.","example":"name"},"vop_request.details":{"type":"object","description":"Details of a payee verification request.","required":["id","object","status","status_details","direction","scheme","request","matching_result","payee_suggested_name","matching_details","scheme_data","created_at"],"properties":{"id":{"type":"string","description":"The ID of the payee verification request.","example":"c39d1eff-c5ed-4197-8f24-28a68bd0eee6"},"idempotency_key":{"type":"string","description":"An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.","example":"8A2gcC"},"object":{"type":"string","enum":["payee_verification_request"],"description":"Label used to identify this kind of object.","example":"payee_verification_request"},"status":{"type":"string","enum":["created","received","completed","failed"],"description":"The status of the payee verification request. See Payee verification request lifecycle for more details.","example":"completed"},"status_details":{"type":"string","description":"More information about the payee verification request status.","example":"Some details about the status."},"failure_code":{"type":["string","null"],"description":"A code explaining why the request failed.","enum":["business_error","technical_error","psp_technical_error"],"example":"business_error"},"direction":{"type":"string","enum":["outgoing","incoming"],"description":"The direction of the request. Can be outgoing or incoming.","example":"incoming"},"scheme":{"type":"string","enum":["vop"],"description":"The scheme the request was sent on. Only `vop` is supported today.","example":"vop"},"request":{"type":"object","description":"An object containing key information about the request.","properties":{"payee_identification_type":{"type":"string","description":"The type of identification used in the request.","example":"name"},"payee_identification":{"type":"string","description":"The identification of the payee.","example":"John Doe"},"sent_identification":{"type":["string","null"],"description":"The identification actually sent on the scheme, after any cleaning or transformation applied to `payee_identification`. Only available for outgoing requests.","example":"John Doe"},"payee_account_number":{"type":"string","description":"The account number of the payee.","example":"FR5012739000308682265435N36"},"additional_information":{"type":"string","description":"Additional information about the payee.","example":"Account 123-ABC"},"requesting_agent_bank_code":{"type":"string","description":"The agent which sent the request.","example":"SOMEBICXXX"},"responding_agent_bank_code":{"type":"string","description":"The agent at which the request is aimed, i.e. the agent of the payee.","example":"BANKITPPXXX"}}},"matching_result":{"type":"string","enum":["match","close_match","no_match","impossible_match"],"description":"The result of the verification. Can be `match`, `close_match`, `no_match` or `impossible_match`. Note that `close_match` is only possible when `payee_identification_type = name`.","example":"match"},"payee_suggested_name":{"type":["string","null"],"description":"In case of `matching_result = close_match`, name suggested as correct by the responding agent.","example":null},"matching_details":{"type":["object","null"],"description":"Details of the request processing in case `direction = incoming`.","properties":{"cleaned_identification":{"type":"string","description":"Payee identification after data cleaning (removing double spaces, honorific titles, etc.)","example":"John Doe"},"retrieved_identification":{"type":["string","null"],"description":"Payee identification retrieved in your account database (in Numeral or in your systems), using `payee_account_number` as a search key. For name matching: set to the best matching name when `matching_result` is `match` or `close_match`, null when `matching_result` is `no_match`. For other identification types (LEI, BIC, etc.): set to the retrieved value.","example":"John Doe"},"retrieved_identifications":{"type":["array","null"],"items":{"type":"string"},"description":"All holder names retrieved from your account database that were evaluated during the matching process. Only populated for `payee_identification_type = name`. Null for other identification types.","example":["John Doe","J. Doe","John M. Doe"]},"internal_account_id":{"type":"string","description":"If your account database is held in Numeral using internal accounts, the ID of the internal account matching `payee_account_number`.","example":"c39d1eff-c5ed-4197-8f24-28a68bd0eee6"},"matching_score":{"type":"integer","minimum":0,"maximum":100,"description":"The score, from 0 to 100, of the matching algorithm configured for your entity when run with `cleaned_identification` and `retrieved_identification`.","example":100},"distance":{"type":["string","null"],"description":"The name of the matching algorithm used to compute the matching score.","enum":["levenshtein","jarowinkler"],"example":"levenshtein"},"match_threshold":{"type":["integer","null"],"minimum":0,"maximum":100,"description":"The minimum score threshold configured for a result to be considered a `match`.","example":90},"close_match_threshold":{"type":["integer","null"],"minimum":0,"maximum":100,"description":"The minimum score threshold configured for a result to be considered a `close_match`.","example":75}}},"scheme_data":{"type":["object","null"],"description":"An object containing technical information about the request.","properties":{"scheme_request_id":{"type":"string","description":"The unique ID of the request on the scheme. Different from `id`.","example":"c3d79e5a-2058-4301-8b36-353cb9eb0ca5"},"request_timestamp":{"type":"string","format":"date-time","description":"The timestamp of the creation of the request.","example":"2025-01-26T13:51:10Z"},"response_timestamp":{"type":"string","format":"date-time","description":"The timestamp of the answer to the request.","example":"2025-01-26T13:51:15Z"}}},"response_received_at":{"type":["string","null"],"format":"date-time","description":"The UTC timestamp of the reception of the response to the request. Only available for outgoing requests.","example":"2025-01-26T13:51:15Z"},"initiated_at":{"type":["string","null"],"format":"date-time","description":"The UTC timestamp at which you started the verification request cycle, as provided on creation. Only available for outgoing requests where it was provided.","example":"2025-01-26T13:51:10Z"},"metadata":{"$ref":"#/components/schemas/common.metadata"},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the creation of the outgoing payee verification request.","example":"2025-01-01T12:00:00Z"}}},"vop_request.creation_details":{"type":"object","description":"Details required to create a payee verification request.","required":["scheme","payee_identification_type","payee_identification","payee_account_number"],"properties":{"scheme":{"type":"string","enum":["vop"],"description":"The scheme on which the request will be sent. Only `vop` is supported today.","example":"vop"},"payee_identification_type":{"$ref":"#/components/schemas/vop_request.payee_identification_type"},"payee_identification":{"type":"string","description":"The identification of the payee. For example, if `payee_identification_type = name`, then you should fill the name of the payee here.","example":"John Doe"},"payee_account_number":{"type":"string","description":"The account number of the payee. When `scheme = vop`, must be an IBAN.","example":"FR5012739000308682265435N36"},"payee_additional_information":{"type":"string","description":"Additional information about the payee.","example":"Account 123-ABC","maxLength":140},"requesting_agent_bank_code":{"type":"string","description":"The BIC11 you want to use to send your request. Must be one of the BIC11 configured in Numeral for your company.","example":"BANKITPPXXX"},"initiated_at":{"type":"string","format":"date-time","description":"The UTC timestamp at which you started the verification request cycle. It is forwarded unchanged to the counterparty as the request timestamp. Must not be in the future and must be less than 5 seconds old.","example":"2025-01-26T13:51:10Z"},"metadata":{"$ref":"#/components/schemas/common.metadata"}}},"vop_request.simulate_incoming_creation_details":{"type":"object","description":"Details required to simulate an incoming payee verification request.","required":["scheme","payee_identification_type","payee_identification","payee_account_number","responding_agent_bank_code"],"properties":{"scheme":{"type":"string","enum":["vop"],"description":"The scheme of the request you want to simulate. Only `vop` is supported.","example":"vop"},"payee_identification_type":{"$ref":"#/components/schemas/vop_request.payee_identification_type"},"payee_identification":{"type":"string","description":"The identification of the payee. For example, if `payee_identification_type = name`, then you should fill the name of the payee here.","example":"John Doe"},"payee_account_number":{"type":"string","description":"The account number of the payee. When `scheme = vop`, must be an IBAN.","example":"FR5012739000308682265435N36"},"payee_additional_information":{"type":"string","description":"Additional information about the payee.","example":"Account 123-ABC","maxLength":140},"requesting_agent_bank_code":{"type":"string","description":"The BIC of the requesting agent sending the request in your simulation.","example":"BANKITPPXXX"},"matching_algorithm":{"type":"string","enum":["levenshtein","jaro-winkler"],"description":"The matching algorithm you want to use to respond to this request. Supported values are `levenshtein` and `jaro-winkler`.","example":"levenshtein"},"min_score_match":{"type":"integer","description":"The matching score above which you want the matching result to be `match`.","example":90},"min_score_close_match":{"type":"integer","description":"The matching score below which you want the matching result to be `close_match`. When matching score is between `min_score_match` and `min_score_close_match`, matching result will be `close_match`.","example":75},"responding_agent_bank_code":{"type":"string","description":"The BIC of the responding agent receiving the request in your simulation.","example":"BANKITPPXXX"},"metadata":{"$ref":"#/components/schemas/common.metadata"}}},"vop_request.supported_identification_types_response":{"type":"object","description":"Response containing supported identification types for a given payee account","required":["payee_account_number","payee_agent","supported_identification_types"],"properties":{"payee_account_number":{"type":"string","description":"The account number of the payee.","example":"FR9217569000703512315552Z46"},"payee_agent":{"type":"string","description":"The agent (BIC) of the payee.","example":"BANKFRPP123"},"supported_identification_types":{"type":"array","description":"The list of identification types supported by the payee's agent.","items":{"type":"string"},"example":["lei","eu_vat"]}}},"verification_scheme_participant.operational_contact":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email address of the operational contact.","example":"user1@mail.com"}}},"verification_scheme_participant.scheme_uri":{"type":"object","required":["environment","operation","api_uri","api_version","priority_number","account_holding_bics","start_date_time"],"properties":{"environment":{"type":"string","description":"Environment indicator (L for Live, T for Test).","enum":["L","T"],"example":"L"},"operation":{"type":"string","description":"API operation identifier.","example":"postVerificationOfPayeeRequests"},"api_uri":{"type":"string","description":"URI of the API endpoint.","example":"https://vopxxx.bankbic.com/vop/v1/payee-verifications"},"api_version":{"type":"integer","description":"Version of the API.","example":1},"priority_number":{"type":"integer","description":"Priority of this URI (lower number means higher priority).","example":1},"account_holding_bics":{"type":"array","description":"List of BICs for which this URI is valid.","items":{"type":"string"},"example":["DEUTBEFFXXX","DEUTITFFXXX"]},"start_date_time":{"type":"string","format":"date-time","description":"Start date and time from which this URI is valid.","example":"2025-09-12T00:00:00Z"},"end_date_time":{"type":"string","format":"date-time","description":"End date and time until which this URI is valid.","example":"2026-03-01T00:00:00Z"},"note":{"type":"string","description":"Additional notes about this URI.","example":"My first added url"}}},"verification_scheme_participant.scheme_role":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Code representing the role in the scheme.","example":"REQUES"}}},"verification_scheme_participant.scheme_option":{"type":"object","required":["code","readiness_date"],"properties":{"code":{"type":"string","description":"Option code.","example":"INACNO"},"readiness_date":{"type":"string","format":"date","description":"Date from which the option is ready to be used.","example":"2025-02-01"},"leaving_date":{"type":"string","format":"date","description":"Date until which the option is available.","example":"2025-12-31"}}},"verification_scheme_participant.scheme":{"type":"object","required":["code","uris","roles","options","readiness_date"],"properties":{"code":{"type":"string","description":"Code of the verification scheme.","example":"VOP"},"uris":{"type":"array","description":"List of API URIs for this scheme.","items":{"$ref":"#/components/schemas/verification_scheme_participant.scheme_uri"}},"roles":{"type":"array","description":"Roles of the participant in this scheme.","items":{"$ref":"#/components/schemas/verification_scheme_participant.scheme_role"}},"options":{"type":"array","description":"Options supported by the participant in this scheme.","items":{"$ref":"#/components/schemas/verification_scheme_participant.scheme_option"}},"readiness_date":{"type":"string","format":"date","description":"Date from which the participant is ready to operate in this scheme.","example":"2025-02-01"},"leaving_date":{"type":"string","format":"date","description":"Date until which the participant is part of this scheme.","example":"2025-12-31"}}},"bulk_action.item":{"type":"object","description":"A single payee verification request in a bulk action.","required":["scheme","payee_identification_type","payee_identification","payee_account_number"],"properties":{"idempotency_key":{"type":"string","description":"Optional idempotency key for this specific item.","example":"test-bulk-1","maxLength":255},"scheme":{"type":"string","enum":["vop"],"description":"The scheme on which the request will be sent. Only `vop` is supported today.","example":"vop"},"payee_identification_type":{"$ref":"#/components/schemas/vop_request.payee_identification_type"},"payee_identification":{"type":"string","description":"The identification of the payee.","example":"Test Company Ltd"},"payee_account_number":{"type":"string","description":"The account number of the payee. Must be an IBAN.","example":"FR1420041010050500013M02606"},"payee_additional_information":{"type":"string","description":"Additional information about the payee.","example":"Account 123-ABC","maxLength":140},"requesting_agent_bank_code":{"type":"string","description":"The BIC11 you want to use to send your request.","example":"BANKITPPXXX"},"metadata":{"$ref":"#/components/schemas/common.metadata"}}},"bulk_action.creation":{"type":"object","description":"Details required to create a bulk action for payee verification requests.","required":["items"],"properties":{"fail_on_validation_error":{"type":"boolean","description":"If true, all items must pass validation or the request returns a 400 error. If false, items that fail validation are marked as failed, and valid items are processed. Default is true.","example":false,"default":true},"items":{"type":"array","description":"Array of payee verification requests to create in bulk.","minItems":1,"items":{"$ref":"#/components/schemas/bulk_action.item"}}}},"bulk_action.details":{"type":"object","description":"Details of a bulk action for payee verification requests.","required":["id","object","status","total_items","total_successful","total_failed","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the bulk action.","example":"7eccce97-40ad-41ac-99e3-06155bdf9d63"},"object":{"type":"string","enum":["bulk_action"],"description":"Label used to identify this kind of object.","example":"bulk_action"},"status":{"type":"string","enum":["created","processing","executed"],"description":"The status of the bulk action. `created` means the action was created, `processing` means items are being processed, `executed` means all items have been processed.","example":"created"},"total_items":{"type":"integer","description":"Total number of items submitted in the bulk action.","example":2},"total_successful":{"type":"integer","description":"Number of items that were successfully processed.","example":0},"total_failed":{"type":"integer","description":"Number of items that failed during processing.","example":1},"processed_at":{"type":["string","null"],"format":"date-time","description":"The UTC timestamp when the bulk action finished processing. Null if not yet processed.","example":"2025-10-14T09:40:07.929609Z"},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp when the bulk action was created.","example":"2025-10-14T09:40:03.337743Z"}}},"bulk_action.item_result":{"type":"object","description":"Result of a single item in a bulk action.","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The ID of the payee verification request. Null if the item failed.","example":"c39d1eff-c5ed-4197-8f24-28a68bd0eee6"},"idempotency_key":{"type":["string","null"],"description":"The idempotency key of the item.","example":"test-bulk-1"},"error":{"type":["string","null"],"description":"Error code if the item failed. Null if successful.","example":"validation_error"},"message":{"type":["string","null"],"description":"Error message if the item failed. Null if successful.","example":"validation errors occurred while processing request"},"details":{"type":["object","null"],"description":"Detailed error information if the item failed."},"correlation_id":{"type":["string","null"],"format":"uuid","description":"Correlation ID for tracing the error."}}},"bulk_action.items_response":{"type":"object","description":"Response containing the items of a bulk action.","allOf":[{"$ref":"#/components/schemas/bulk_action.details"},{"type":"object","properties":{"succeeded":{"type":"array","description":"Array of items that succeeded.","items":{"$ref":"#/components/schemas/bulk_action.item_result"}},"failed":{"type":"array","description":"Array of items that failed.","items":{"$ref":"#/components/schemas/bulk_action.item_result"}}}}]},"verification_scheme_participant.details":{"type":"object","description":"Details of a verification scheme participant.","required":["participant_bic","participant_name","country_code","psd2_nans","operational_contacts","schemes"],"properties":{"participant_bic":{"type":"string","description":"The BIC of the participant.","example":"DEUTDEFFXXX"},"participant_name":{"type":"string","description":"The name of the participant.","example":"Bank Name"},"country_code":{"type":"string","description":"The country code of the participant.","example":"DE"},"psd2_nans":{"type":"array","description":"PSD2 National Authorization Numbers of the participant.","items":{"type":"string"},"example":["W-12345678"]},"operational_contacts":{"type":"array","description":"Operational contacts of the participant.","items":{"$ref":"#/components/schemas/verification_scheme_participant.operational_contact"}},"schemes":{"type":"array","description":"Schemes the participant is part of.","items":{"$ref":"#/components/schemas/verification_scheme_participant.scheme"}}}}}},"security":[{"sec0":[]}],"paths":{"/payee_verification_requests":{"post":{"summary":"Send verification payee request","description":"Send a request to verify your payee's information.","operationId":"send-payee-verification-request","tags":["payee-verification-requests"],"parameters":[{"$ref":"#/components/parameters/vop_request.create_parameters.idempotency_key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vop_request.creation_details"}}}},"responses":{"200":{"description":"Successfully created payee verification request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vop_request.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}},"get":{"summary":"List payee verification requests","description":"List and filter payee verification requests.","operationId":"list-payee-verification-requests","tags":["payee-verification-requests"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string"}},{"name":"sort_order","in":"query","description":"Order is based on attribute `created_at`. If `asc`, results are fetched in chronological order. If `desc`, results are fetched in reversed chronological order. Default order is `desc`.\n","schema":{"type":"string","enum":["asc","desc"]}},{"name":"start_date","in":"query","description":"Filter by creation date from.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"Filter by creation date to.","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"Filter by status.","schema":{"type":"string","enum":["created","completed","failed","received"]}},{"name":"direction","in":"query","description":"Filter by direction.","schema":{"type":"string","enum":["outgoing","incoming"]}},{"name":"scheme","in":"query","description":"Filter by scheme.","schema":{"type":"string","enum":["vop"]}},{"name":"payee_identification_type","in":"query","description":"The payee identification type used in the payee verification request.","schema":{"type":"string"}},{"name":"payee_identification","in":"query","description":"The payee identification used in the payee verification request.","schema":{"type":"string"}},{"name":"payee_account_number","in":"query","description":"The payee account number used in the payee verification request.","schema":{"type":"string"}},{"name":"requesting_agent_bank_code","in":"query","description":"The requesting agent of the payee verification request.","schema":{"type":"string"}},{"name":"responding_agent_bank_code","in":"query","description":"The responding agent of the payee verification request.","schema":{"type":"string"}},{"name":"matching_result","in":"query","description":"The matching result agent of the payee verification request.","schema":{"type":"string","enum":["match","close_match","no_match","impossible_match"]}},{"name":"internal_account_id","in":"query","description":"The ID of the internal account of the payee verification request.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of filtered payee verification requests","content":{"application/json":{"schema":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/vop_request.details"}}}}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/payee_verification_requests/{id}":{"get":{"summary":"Retrieve payee verification request","description":"Retrieve the details of a payee verification request.","operationId":"retrieve-payee-verification-request","tags":["payee-verification-requests"],"parameters":[{"name":"id","in":"path","description":"The ID of the payee verification request.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successfully retrieved payee verification request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vop_request.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/payee_verification_requests/simulate":{"post":{"summary":"Simulate incoming payee verification request","description":"Simulate an incoming payee verification request for testing and development purposes.","operationId":"simulate-incoming-payee-verification-request","tags":["payee-verification-requests"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vop_request.simulate_incoming_creation_details"}}}},"responses":{"200":{"description":"Successfully simulated incoming payee verification request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vop_request.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/bulk_actions/payee_verification_requests":{"post":{"summary":"Create payee verification requests in bulk","description":"Create up to 5,000 payee verification requests in a single bulk action. Requests are processed asynchronously and you can choose whether to fail immediately on validation errors, or process valid items while marking invalid ones as failed.","operationId":"create-bulk-payee-verification-requests","tags":["payee-verification-requests"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_action.creation"}}}},"responses":{"200":{"description":"Successfully created bulk action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_action.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/bulk_actions/payee_verification_requests/{id}":{"get":{"summary":"Retrieve bulk action","description":"Retrieve the details of a bulk action, including its status and progress.","operationId":"retrieve-bulk-payee-verification-action","tags":["payee-verification-requests"],"parameters":[{"name":"id","in":"path","description":"The ID of the bulk action.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"Successfully retrieved bulk action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_action.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/bulk_actions/payee_verification_requests/{id}/items":{"get":{"summary":"Retrieve bulk action items","description":"Retrieve the detailed results of all items in a bulk action, including which items succeeded and which failed with error details.","operationId":"retrieve-bulk-payee-verification-action-items","tags":["payee-verification-requests"],"parameters":[{"name":"id","in":"path","description":"The ID of the bulk action.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"Successfully retrieved bulk action items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_action.items_response"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/supported_identification_types":{"get":{"summary":"Get supported identification types for a payee account","description":"Get the list of identification types supported by the payee's agent for a given payee account number.","operationId":"get-supported-identification-types","tags":["verification-scheme-participants"],"parameters":[{"name":"payee_account_number","in":"query","required":true,"description":"The account number of the payee (must be an IBAN).","schema":{"type":"string","example":"FR9217569000703512315552Z46"}}],"responses":{"200":{"description":"Successfully retrieved the supported identification types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/vop_request.supported_identification_types_response"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"description":"BIC cannot be extracted or agent is not a participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}},"/verification_scheme_participants/{participant_bic}":{"get":{"summary":"Retrieve verification scheme participant","description":"Retrieve the details of a verification scheme participant.","operationId":"get-verification-scheme-participant-reference","tags":["verification-scheme-participants"],"parameters":[{"name":"participant_bic","in":"path","description":"The participant BIC of the verification scheme participant.","schema":{"type":"string","example":"DEUTDEFFXXX"},"required":true}],"responses":{"200":{"description":"Successfully retrieved verification scheme participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verification_scheme_participant.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"500":{"$ref":"#/components/responses/errors.500.internal_server_error"}}}}}}