Introduction
Harmoney API Gateway (software version 20.0.0)
callback
This cannot be called, but acts as an example of what is expected to be handled properly when using a callbackUrl.
cancel_information_exchange
This service cancels the ongoing/pending information exchange.
create_flow_completion_result
This service can be used to create a new flow completion result for a dossier that has no existing flow completion results.
create_information_exchange_completion
This service posts an externally completed information exchange (with profiles) to a dossier.
create_information_exchange
This service creates a new information exchange on a dossier for a given counterparty. When a pending information exchange already exists for the same counterparty, that one is returned as-is.
create_update_dossier
This API-gateway service call creates or updates a dossier.
create_update_party
This API-gateway service call creates or updates a party.
get_dossier_question_answers
This service retrieves the question answers of an existing dossier.
get_dossier_rba_result
This service can be used to retrieve the RBA (Risk Based Approach) results for an existing dossier (if available).
get_dossier
This service retrieves the dossier details from an existing dossier.
get_flow_completion_questionnaire_answers
This service can be used to retrieve all the answers of a flow completion performed by the responsible person(s) of the dossier.
get_flow_completion_results
This service can be used to retrieve the results of the flow completion performed by the responsible person(s) of the dossier.
get_information_exchange_answers
This service retrieves all the questionnaire answers of an information exchange.
get_information_exchange
This service retrieves a single information exchange of a dossier.
get_information_exchanges
This service retrieves all information exchanges of a dossier.
get_party_question_answers
This service retrieves the question answers of an existing party.
get_party
This service retrieves the party details from an existing party.
get_questionnaire_answers
This service can be used to retrieve all the answers of dossier questionnaires of the dossier.
health_check
This service is meant to check if the Harmoney server is up and running.
initiate_information_exchange
This service initiates an ongoing/pending information exchange by selecting a flow option, returning the url and/or code to complete it.
initiate_responsible_flow
This API-gateway service call performs the necessary actions to initiate the flow for a specific responsible on a dossier.
trigger_dossier_automation
Triggers the given automation for an existing dossier. The automation is executed asynchronously.
update_dossier_question_answers
This API-gateway service call updates the question answers of an existing dossier. It's advised to use updateStrategy=APPEND when updating the question answers.Provided answers will only appear in the application if the question is already visible based on the form definition.Invalid answers will not be accepted by the system.
update_party_question_answers
This API-gateway service call updates the question answers of an existing party. It's advised to use updateStrategy=APPEND when updating the question answers. Provided answers will only appear in the application if the question is already visible based on the form definition. Invalid answers will not be accepted by the system.