Download OpenAPI specification:
Service for trade financing validation, fingerprinting and matching
APIs that communicate between the bank and a trade receivables validation, fingerprinting and matching service.
Registers and optionally requests to finance the assets/transactions identified by the provided identifications at the validation service.
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
| pool_identification | string (Max35Text) [ 1 .. 35 ] characters Specifies a character string with a maximum length of 35 characters. |
| submitting_financial_institution_identification | string (BicOrUuidIdentifier) <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]... Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". |
required | Array of objects (BatchInformation3) |
{- "pool_identification": "string",
- "submitting_financial_institution_identification": "string",
- "batch_collection": [
- {
- "submitter_batch_identification": "string",
- "data_set_validation_service": "REGI",
- "batch_booking": true,
- "financing_validation_request_details": [
- {
- "submitter_data_set_identification": "string",
- "financing_applicant": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": null,
- "proprietary": null
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "collateral_type": "TREC",
- "pre_shipment_financing": true,
- "with_recourse": true,
- "financing_request_amount": {
- "currency": "string",
- "amount": "string"
}, - "referred_documents": [
- {
- "submitter_document_reference": "string",
- "country_of_issue": "string",
- "trade_utility_service": [
- {
- "service_name": "LLI_VALIDATION",
- "record_identifier": "string",
- "record_owner_identification": "string",
- "record_owner_contact_emails": [
- null
]
}
], - "document_summary": {
- "document_type": "CINV",
- "document_issuer_identification": {
- "name": "string",
- "identifications": {
- "any_bic": null,
- "lei": null,
- "email_address": null,
- "other": [ ]
}, - "country_of_domicile": "string"
}, - "issue_date": "string",
- "seller_identification": {
- "name": "string",
- "identifications": {
- "any_bic": null,
- "lei": null,
- "email_address": null,
- "other": [ ]
}, - "country_of_domicile": "string"
}, - "buyer_identification": {
- "name": "string",
- "identifications": {
- "any_bic": null,
- "lei": null,
- "email_address": null,
- "other": [ ]
}, - "country_of_domicile": "string"
}, - "invoice_number": "string",
- "total_invoice_amount": {
- "currency": "string",
- "amount": "string"
}, - "commercial_line_items": [
- {
- "line_item_identification": null,
- "quantity": null,
- "unit_price": null,
- "product_name": null,
- "product_identifier": null
}
], - "ship_to_name": "string",
- "ship_to_address_line": [
- "string"
], - "ship_to_country": "string",
- "payment_method": "CHK",
- "invoice_type": "SALES",
- "other_reference_numbers": [
- [
- null
]
]
}
}
]
}
]
}
]
}{- "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}Requests the assets/transactions identified by the provided identifications to be marked as financed by the caller at the validation service.
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
| submitting_financial_institution_identification required | string (BicOrUuidIdentifier) <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]... Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". |
| batch_booking | boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element. |
| batch_booking_override | boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element. |
required | Array of objects (BatchInformation5) |
{- "submitting_financial_institution_identification": "SWHQBEBBXXX",
- "financing_batch": [
- {
- "pool_identification": "AZN20200110"
}
]
}{- "request_identification": "123e4567-e89b-42d3-a456-426614174000"
}The response includes pagination metadata for financing validation requests registered under the specified request-identification. include-cancelled applies to the returned result set. include-fvrs-with-similarity and include-similarity do not affect filtering or the pagination count.
| request-identification required | string <uuid> Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Used to retrieve the statuses of previous registrations, financings and status requests. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. |
| offset | integer >= 0 Default: 0 Example: offset=20 Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. |
| limit | integer >= 1 Example: limit=20 The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. |
| include-cancelled | boolean Example: include-cancelled=true Include or exclude cancelled FVRs and their matches (defaults to include) |
| include-similarity | MatchSimilarity Deprecated Example: include-similarity=CRITICAL_SIMILARITY Only include matches of a specific similarity levels |
| include-matches-with-similarity | MatchSimilarity Example: include-matches-with-similarity=CRITICAL_SIMILARITY Only include duplicate reports for matches of specific similarity levels |
| include-fvrs-with-similarity | MatchSimilarity Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY Only include FVRs that have matches of specific similarity levels |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "links": [
- {
- "rel": "self",
- "type": "GET"
}, - {
- "rel": "first",
- "type": "GET"
}, - {
- "rel": "next",
- "type": "GET"
}, - {
- "rel": "previous",
- "type": "GET"
}, - {
- "rel": "last",
- "type": "GET"
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 0
}, - "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
- "submitting_financial_institution_identification": "string",
- "creation_date_time": "string",
- "financing_validation_data_set_details": [
- {
- "request_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "pool_identification": "string",
- "submitter_batch_identification": "string",
- "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "batch_booking": true,
- "submitter_data_set_identification": "string",
- "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "data_set_validation_service": "REGI",
- "financing_applicant": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "financed_amount": {
- "currency": "string",
- "amount": "string"
}, - "collateral_type": "TREC",
- "pre_shipment_financing": true,
- "with_recourse": true,
- "referred_documents": [
- {
- "submitter_document_reference": "string",
- "country_of_issue": "string",
- "trade_utility_service": [
- {
- "service_name": "LLI_VALIDATION",
- "record_identifier": "string",
- "record_owner_identification": "string",
- "record_owner_contact_emails": [
- "string"
]
}
], - "document_summary": {
- "document_type": "CINV",
- "document_issuer_identification": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": null,
- "scheme_name": null,
- "issuer": null
}
]
}, - "country_of_domicile": "string"
}, - "issue_date": "string",
- "seller_identification": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": null,
- "scheme_name": null,
- "issuer": null
}
]
}, - "country_of_domicile": "string"
}, - "buyer_identification": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": null,
- "scheme_name": null,
- "issuer": null
}
]
}, - "country_of_domicile": "string"
}, - "invoice_number": "string",
- "total_invoice_amount": {
- "currency": "string",
- "amount": "string"
}, - "commercial_line_items": [
- {
- "line_item_identification": "string",
- "quantity": {
- "unit_of_measure": {
- "unit_of_measure_code": null,
- "other_unit_of_measure": null
}, - "value": "string",
- "factor": "string"
}, - "unit_price": {
- "currency": "string",
- "amount": "string"
}, - "product_name": "string",
- "product_identifier": {
- "structured_product_identifier": {
- "type": null,
- "identifier": null
}, - "other_product_identifier": {
- "identification": null,
- "identification_type": null
}
}
}
], - "ship_to_name": "string",
- "ship_to_address_line": [
- "string"
], - "ship_to_country": "string",
- "payment_method": "CHK",
- "invoice_type": "SALES",
- "other_reference_numbers": [
- [
- {
- "gst_e_way_bill_number": "181000123456"
}
]
]
}, - "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "trade_utility_matching": [
- {
- "business_service": "GSTN_goods_and_services_tax_network",
- "current_status_date_time": "2020-01-10T16:29:20.000+00:00",
- "validation_status": "VALD",
- "matching_report": [
- {
- "element_name": "invoice_number",
- "matching_status": "MACH"
}
]
}
], - "trade_utility_data": [
- {
- "business_service": "LLI_VALIDATION",
- "current_status_date_time": "string",
- "trade_utility_data_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
], - "document_duplicate_matches": {
- "exact_matches": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
], - "partial_matches": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
}
], - "financing_request_status": "DFIN",
- "financing_request_duplicate_report": [
- {
- "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "match_type": "EXCT",
- "matched_financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": null,
- "proprietary": null
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "matched_financing_request_status": "DFIN",
- "matched_financing_request_amount": {
- "currency": "string",
- "amount": "string"
}, - "financing_applicant_is_matched": true,
- "bl_transfer": true,
- "matched_date_time": "string",
- "proprietary_matching_details": {
- "proprietary_description": "string",
- "proprietary_classifier_result_description": "string",
- "proprietary_classifier_result_identification": "string"
}, - "related_document_match_identifications": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
], - "errors": [
- {
- "title": "You do not have enough credit.",
- "status": "405",
- "detail": "Your current balance is 30, but that costs 50",
- "instance": "/account/12345/",
- "error": "655617",
- "path": "/api/book/1",
- "timestamp": "2020-08-06T14:16:27.520Z"
}
], - "created_timestamp": "string",
- "updated_timestamp": "string"
}
]
}Returns a metadata-only subset of /status/{request-identification} using the same filtering and pagination semantics. include-fvrs-with-similarity and include-similarity do not affect filtering or the pagination count.
| request-identification required | string <uuid> Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Used to retrieve the statuses of previous registrations, financings and status requests. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. |
| offset | integer >= 0 Default: 0 Example: offset=20 Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. |
| limit | integer >= 1 Example: limit=20 The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. |
| include-cancelled | boolean Example: include-cancelled=true Include or exclude cancelled FVRs and their matches (defaults to include) |
| include-similarity | MatchSimilarity Deprecated Example: include-similarity=CRITICAL_SIMILARITY Only include matches of a specific similarity levels |
| include-matches-with-similarity | MatchSimilarity Example: include-matches-with-similarity=CRITICAL_SIMILARITY Only include duplicate reports for matches of specific similarity levels |
| include-fvrs-with-similarity | MatchSimilarity Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY Only include FVRs that have matches of specific similarity levels |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "links": [
- {
- "rel": "self",
- "type": "GET"
}, - {
- "rel": "first",
- "type": "GET"
}, - {
- "rel": "next",
- "type": "GET"
}, - {
- "rel": "previous",
- "type": "GET"
}, - {
- "rel": "last",
- "type": "GET"
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 0
}, - "request_identification": "e02185b9-9dde-44fe-99c4-b5a6b89f4be4",
- "submitting_financial_institution_identification": "string",
- "creation_date_time": "string",
- "financing_validation_data_set_details": [
- {
- "request_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "pool_identification": "string",
- "submitter_batch_identification": "string",
- "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "submitter_data_set_identification": "string",
- "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "data_set_validation_service": "REGI",
- "financing_request_status": "DFIN",
- "financing_request_duplicate_report": [
- {
- "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "match_type": "EXCT",
- "matched_financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": null,
- "proprietary": null
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "matched_financing_request_status": "DFIN",
- "matched_financing_request_amount": {
- "currency": "string",
- "amount": "string"
}, - "financing_applicant_is_matched": true,
- "bl_transfer": true,
- "matched_date_time": "string",
- "proprietary_matching_details": {
- "proprietary_description": "string",
- "proprietary_classifier_result_description": "string",
- "proprietary_classifier_result_identification": "string"
}, - "related_document_match_identifications": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
], - "errors": [
- {
- "title": "You do not have enough credit.",
- "status": "405",
- "detail": "Your current balance is 30, but that costs 50",
- "instance": "/account/12345/",
- "error": "655617",
- "path": "/api/book/1",
- "timestamp": "2020-08-06T14:16:27.520Z"
}
], - "created_timestamp": "string",
- "updated_timestamp": "string"
}
]
}The response includes pagination metadata for financing validation requests that match the query filters. include-cancelled does not change which requests return; it only controls whether cancelled duplicate matches appear in each result's duplicate report.
| offset | integer >= 0 Default: 0 Example: offset=20 Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. |
| limit | integer >= 1 Example: limit=20 The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. |
| sort | string Example: sort=-created_timestamp,submitter_data_set_id Field(s) to sort by, separated by commas. Optionally, a leading |
| after | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: after=2021-03-29T11:00:23.000Z Timestamp after which financing validation requests have been created |
| before | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: before=2021-03-29T11:00:23.000Z Timestamp before which financing validation requests have been created. Default is current time |
| financed-currency | string^[A-Z]{3,3}$ ISO 4217 Currency code filter |
| financing-beneficiary-name | string <= 70 characters Financing beneficiary name filter |
| collateral-type | string Enum: "TREC" "OTGI" "CASH" Collateral type filter |
| pre-shipment-financing | boolean Pre-shipment financing filter |
| with-recourse | boolean With recourse filter |
| financing-request-status | string Enum: "REDU" "REGU" "DFIN" "FNCD" "CANC" "BATD" Financing request status filter |
| duplicate-match-type | string Enum: "EXCT" "PART" Duplicate match filter (exact or partial) |
| duplicate-matches | boolean Duplicate match filter (one or more of any type) |
| pool-identification | string <= 35 characters Example: pool-identification=pool-1234 Pool identification that is sent when a pool is created |
| data-set-identification | string Example: data-set-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 Fvr identification generated by SFA server |
| batch-identification | string Example: batch-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 Batch identification generated by the SFA server for an fvr request |
| request-identification | string Example: request-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 Request identification given by the SFA server after the creation of an fvr or a financing request |
| submitter-batch-identification | string <= 35 characters Submitter batch identification |
| submitter-data-set-identification | string <= 35 characters Submitter data set identification |
| submitter-document-identification | string <= 35 characters Submitter document identification |
| include-cancelled | boolean Example: include-cancelled=true Include or exclude cancelled FVRs and their matches (defaults to include) |
| include-similarity | MatchSimilarity Deprecated Example: include-similarity=CRITICAL_SIMILARITY Only include matches of a specific similarity levels |
| include-matches-with-similarity | MatchSimilarity Example: include-matches-with-similarity=CRITICAL_SIMILARITY Only include duplicate reports for matches of specific similarity levels |
| include-fvrs-with-similarity | MatchSimilarity Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY Only include FVRs that have matches of specific similarity levels |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "links": [
- {
- "rel": "self",
- "type": "GET"
}, - {
- "rel": "first",
- "type": "GET"
}, - {
- "rel": "next",
- "type": "GET"
}, - {
- "rel": "previous",
- "type": "GET"
}, - {
- "rel": "last",
- "type": "GET"
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 0
}, - "submitting_financial_institution_identification": "string",
- "financing_validation_data_set_details": [
- {
- "request_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "pool_identification": "string",
- "submitter_batch_identification": "string",
- "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "batch_booking": true,
- "submitter_data_set_identification": "string",
- "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "data_set_validation_service": "REGI",
- "financing_applicant": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "financed_amount": {
- "currency": "string",
- "amount": "string"
}, - "collateral_type": "TREC",
- "pre_shipment_financing": true,
- "with_recourse": true,
- "referred_documents": [
- {
- "submitter_document_reference": "string",
- "country_of_issue": "string",
- "trade_utility_service": [
- {
- "service_name": "LLI_VALIDATION",
- "record_identifier": "string",
- "record_owner_identification": "string",
- "record_owner_contact_emails": [
- "string"
]
}
], - "document_summary": {
- "document_type": "CINV",
- "document_issuer_identification": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": null,
- "scheme_name": null,
- "issuer": null
}
]
}, - "country_of_domicile": "string"
}, - "issue_date": "string",
- "seller_identification": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": null,
- "scheme_name": null,
- "issuer": null
}
]
}, - "country_of_domicile": "string"
}, - "buyer_identification": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": null,
- "scheme_name": null,
- "issuer": null
}
]
}, - "country_of_domicile": "string"
}, - "invoice_number": "string",
- "total_invoice_amount": {
- "currency": "string",
- "amount": "string"
}, - "commercial_line_items": [
- {
- "line_item_identification": "string",
- "quantity": {
- "unit_of_measure": {
- "unit_of_measure_code": null,
- "other_unit_of_measure": null
}, - "value": "string",
- "factor": "string"
}, - "unit_price": {
- "currency": "string",
- "amount": "string"
}, - "product_name": "string",
- "product_identifier": {
- "structured_product_identifier": {
- "type": null,
- "identifier": null
}, - "other_product_identifier": {
- "identification": null,
- "identification_type": null
}
}
}
], - "ship_to_name": "string",
- "ship_to_address_line": [
- "string"
], - "ship_to_country": "string",
- "payment_method": "CHK",
- "invoice_type": "SALES",
- "other_reference_numbers": [
- [
- {
- "gst_e_way_bill_number": "181000123456"
}
]
]
}, - "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "trade_utility_matching": [
- {
- "business_service": "GSTN_goods_and_services_tax_network",
- "current_status_date_time": "2020-01-10T16:29:20.000+00:00",
- "validation_status": "VALD",
- "matching_report": [
- {
- "element_name": "invoice_number",
- "matching_status": "MACH"
}
]
}
], - "trade_utility_data": [
- {
- "business_service": "LLI_VALIDATION",
- "current_status_date_time": "string",
- "trade_utility_data_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
], - "document_duplicate_matches": {
- "exact_matches": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
], - "partial_matches": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
}
], - "financing_request_status": "DFIN",
- "financing_request_duplicate_report": [
- {
- "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "match_type": "EXCT",
- "matched_financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": null,
- "proprietary": null
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "matched_financing_request_status": "DFIN",
- "matched_financing_request_amount": {
- "currency": "string",
- "amount": "string"
}, - "financing_applicant_is_matched": true,
- "bl_transfer": true,
- "matched_date_time": "string",
- "proprietary_matching_details": {
- "proprietary_description": "string",
- "proprietary_classifier_result_description": "string",
- "proprietary_classifier_result_identification": "string"
}, - "related_document_match_identifications": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
], - "errors": [
- {
- "title": "You do not have enough credit.",
- "status": "405",
- "detail": "Your current balance is 30, but that costs 50",
- "instance": "/account/12345/",
- "error": "655617",
- "path": "/api/book/1",
- "timestamp": "2020-08-06T14:16:27.520Z"
}
], - "created_timestamp": "string",
- "updated_timestamp": "string"
}
]
}Returns a metadata-only subset of /financing-validation-requests using the same filtering and pagination semantics for cases where full detail is unnecessary.
| offset | integer >= 0 Default: 0 Example: offset=20 Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. |
| limit | integer >= 1 Example: limit=20 The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. |
| sort | string Example: sort=-created_timestamp,submitter_data_set_id Field(s) to sort by, separated by commas. Optionally, a leading |
| after | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: after=2021-03-29T11:00:23.000Z Timestamp after which financing validation requests have been created |
| before | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: before=2021-03-29T11:00:23.000Z Timestamp before which financing validation requests have been created. Default is current time |
| financed-currency | string^[A-Z]{3,3}$ ISO 4217 Currency code filter |
| financing-beneficiary-name | string <= 70 characters Financing beneficiary name filter |
| collateral-type | string Enum: "TREC" "OTGI" "CASH" Collateral type filter |
| pre-shipment-financing | boolean Pre-shipment financing filter |
| with-recourse | boolean With recourse filter |
| financing-request-status | string Enum: "REDU" "REGU" "DFIN" "FNCD" "CANC" "BATD" Financing request status filter |
| duplicate-match-type | string Enum: "EXCT" "PART" Duplicate match filter (exact or partial) |
| duplicate-matches | boolean Duplicate match filter (one or more of any type) |
| pool-identification | string <= 35 characters Example: pool-identification=pool-1234 Pool identification that is sent when a pool is created |
| data-set-identification | string Example: data-set-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 Fvr identification generated by SFA server |
| batch-identification | string Example: batch-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 Batch identification generated by the SFA server for an fvr request |
| request-identification | string Example: request-identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 Request identification given by the SFA server after the creation of an fvr or a financing request |
| submitter-batch-identification | string <= 35 characters Submitter batch identification |
| submitter-data-set-identification | string <= 35 characters Submitter data set identification |
| submitter-document-identification | string <= 35 characters Submitter document identification |
| include-cancelled | boolean Example: include-cancelled=true Include or exclude cancelled FVRs and their matches (defaults to include) |
| include-similarity | MatchSimilarity Deprecated Example: include-similarity=CRITICAL_SIMILARITY Only include matches of a specific similarity levels |
| include-matches-with-similarity | MatchSimilarity Example: include-matches-with-similarity=CRITICAL_SIMILARITY Only include duplicate reports for matches of specific similarity levels |
| include-fvrs-with-similarity | MatchSimilarity Example: include-fvrs-with-similarity=CRITICAL_SIMILARITY Only include FVRs that have matches of specific similarity levels |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "links": [
- {
- "rel": "self",
- "type": "GET"
}, - {
- "rel": "first",
- "type": "GET"
}, - {
- "rel": "next",
- "type": "GET"
}, - {
- "rel": "previous",
- "type": "GET"
}, - {
- "rel": "last",
- "type": "GET"
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 0
}, - "submitting_financial_institution_identification": "string",
- "financing_validation_data_set_details": [
- {
- "request_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "pool_identification": "string",
- "submitter_batch_identification": "string",
- "batch_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "submitter_data_set_identification": "string",
- "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "data_set_validation_service": "REGI",
- "financing_request_status": "DFIN",
- "financing_request_duplicate_report": [
- {
- "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "match_type": "EXCT",
- "matched_financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": null,
- "proprietary": null
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "matched_financing_request_status": "DFIN",
- "matched_financing_request_amount": {
- "currency": "string",
- "amount": "string"
}, - "financing_applicant_is_matched": true,
- "bl_transfer": true,
- "matched_date_time": "string",
- "proprietary_matching_details": {
- "proprietary_description": "string",
- "proprietary_classifier_result_description": "string",
- "proprietary_classifier_result_identification": "string"
}, - "related_document_match_identifications": [
- "d827f76c-c42f-45ae-8972-0597dce2c6e6"
]
}
], - "errors": [
- {
- "title": "You do not have enough credit.",
- "status": "405",
- "detail": "Your current balance is 30, but that costs 50",
- "instance": "/account/12345/",
- "error": "655617",
- "path": "/api/book/1",
- "timestamp": "2020-08-06T14:16:27.520Z"
}
], - "created_timestamp": "string",
- "updated_timestamp": "string"
}
]
}Requests cancellation of registration and financing of assests/transactions identified by the prvided identifications.
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
| submitting_financial_institution_identification required | string (BicOrUuidIdentifier) <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]... Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". |
| batch_booking | boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element. |
| batch_booking_override | boolean (YesNoIndicator) Indicates a "Yes" or "No" type of answer for an element. |
required | Array of objects (BatchInformation6) |
{- "submitting_financial_institution_identification": "SWHQBEBBXXX",
- "cancellation_batch": [
- {
- "pool_identification": "AZN20200110",
- "cancellation_reason": "EXNB"
}, - {
- "batch_identification": "7a3ef62c-6e80-497f-8831-f4a809ef6344",
- "cancellation_reason": "EXNB"
}
]
}{- "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000"
}The response includes pagination metadata for document matches that meet the supplied filters and the calling institution's access scope.
| offset | integer >= 0 Default: 0 Example: offset=20 Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. |
| limit | integer >= 1 Example: limit=20 The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. |
| after | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: after=2021-03-29T11:00:23.000Z Timestamp after which matches have been identified. Default is last 24h |
| before | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: before=2021-03-29T11:00:23.000Z Timestamp before which matches have been identifiedDefault is current time |
| match-type | string Enum: "EXCT" "PART" Exact or Partial matches only |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "links": [
- {
- "rel": "self",
- "type": "GET"
}, - {
- "rel": "first",
- "type": "GET"
}, - {
- "rel": "next",
- "type": "GET"
}, - {
- "rel": "previous",
- "type": "GET"
}, - {
- "rel": "last",
- "type": "GET"
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 0
}, - "matches": [
- {
- "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "match_type": "EXCT",
- "matched_record_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "matched_date_time": "string",
- "matching_report": [
- {
- "element_name": "InvoiceNumber",
- "matching_status": "MACH"
}
], - "proprietary_matching_details": {
- "proprietary_description": "string",
- "proprietary_classifier_result_description": "string",
- "proprietary_classifier_result_identification": "string"
}, - "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "matched_document_a": {
- "financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6"
}, - "matched_document_b": {
- "financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
}
]
}Retrieves individual document match details involving the calling entity as financier.
| match-identification required | string Match identification |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "match_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "match_type": "EXCT",
- "matched_record_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "matched_date_time": "string",
- "matching_report": [
- {
- "element_name": "InvoiceNumber",
- "matching_status": "MACH"
}
], - "proprietary_matching_details": {
- "proprietary_description": "string",
- "proprietary_classifier_result_description": "string",
- "proprietary_classifier_result_identification": "string"
}, - "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "matched_document_a": {
- "financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6"
}, - "matched_document_b": {
- "financing_request_submitter": {
- "name": "string",
- "identifications": {
- "any_bic": "string",
- "lei": "stringstringstringst",
- "email_address": "string",
- "other": [
- {
- "identification": "string",
- "scheme_name": {
- "code": "stri",
- "proprietary": "string"
}, - "issuer": "string"
}
]
}, - "country_of_domicile": "string"
}, - "data_set_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6",
- "registered_document_identification": "d827f76c-c42f-45ae-8972-0597dce2c6e6"
}
}Retrieves cancellation status of receivables at the validation service.
| cancellation-identification required | string <uuid> Example: 789e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "cancellation_identification": "123e4567-e89b-42d3-a456-426614174000",
- "submitting_financial_institution_identification": "SWHQBEBBXXX",
- "cancellation_status_batch": [
- {
- "pool_identification": "pool123",
- "batch_identification": "509a858d-e6d4-496b-9543-5244ab44b271",
- "data_set_identification": "7a3ef62c-6e80-497f-8831-f4a809ef6344",
- "submitter_data_set_identification": "submitterdatasetid123",
- "cancellation_reason": "EXNB",
- "cancellation_status": "PACK"
}
]
}The response includes pagination metadata for activity events that match the supplied filters, enabling clients to retrieve and process new activity results across datasets.
| offset | integer >= 0 Default: 0 Example: offset=20 Specifies the offset / starting point in the list of all available items, starting from which results will be returned. The numeric offset identifies the page token, allowing users to advance to the next page in the collection. The value 0 (zero) identifies the first page of entry. |
| limit | integer >= 1 Example: limit=20 The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. |
| after | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: after=2021-03-29T11:00:23.000Z Timestamp after which to search for events (exclusive). Default is last 24h |
| before | string (ISODateTime) ^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])... Example: before=2021-03-29T11:00:23.000Z Timestamp before which to search for events (inclusive). Default is current time |
| data_set_identification | string Example: data_set_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 fvr identification |
| batch_identification | string Example: batch_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 batch identification coming from an fvr request |
| request_identification | string Example: request_identification=aaa6cb62-3b83-42c1-aad4-f7b2b41a27b9 request identification given by the server after the creation of an fvr or a financing request |
| pool_identification | string Example: pool_identification=pool-1234 pool identification that is sent when a pool is created |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "links": [
- {
- "rel": "self",
- "type": "GET"
}, - {
- "rel": "first",
- "type": "GET"
}, - {
- "rel": "next",
- "type": "GET"
}, - {
- "rel": "previous",
- "type": "GET"
}, - {
- "rel": "last",
- "type": "GET"
}
], - "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "events": [
- {
- "event_identification": "3b9e9c6f-3de1-41b9-9f8f-f911174d426f",
- "event_date_time": "2023-01-10T11:01:43.000Z",
- "pool_identification": "POOL-1234",
- "submitter_batch_identification": "BATCH-1234",
- "batch_identification": "b56cfee7-1a0a-49ba-9260-aeff4fd537c7",
- "submitter_data_set_identification": "FIN-1234",
- "data_set_identification": "8ecef726-f12e-40b9-9722-8878a8d33bc5",
- "sfa_id": "IN-SFA-ID",
- "request_identifications": [
- "9ef2ee9c-a2b7-49bc-a5a9-ef65b4972eab"
], - "event_details": [
- {
- "service_name": "FINANCING_REQUEST_STATUS",
- "status": "REGU"
}
]
}
]
}Endpoints for managing Document Authentication processes (Genuineness Validation) against Trade Utility Services
Retrieves all clients data at the validation service.
| status | string Enum: "PDNG" "EXPD" "COMP"
|
| sort | string Example: sort=-created_timestamp,submitter_data_set_id Field(s) to sort by, separated by commas. Optionally, a leading |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
- "trade_utility_account_holder_identification": {
- "name": "Protean eGov Technologies Limited",
- "identifications": {
- "other": [
- {
- "identification": "33AVXPM6863B1Z0",
- "scheme_name": {
- "proprietary": "IN:GSTIN"
}, - "issuer": "Goods and Services Tax Network"
}
]
}
}, - "trade_utility_account_holder_contacts": [
- {
- "email_address": "info@acmeap.com"
}
], - "trade_utility_credential_requests": [ ],
- "account_identification": "019f64f8-a18b-437a-8ef3-d0b4fddfcbde",
- "account_setup_status": "COMP",
- "account_owner_consent_email_address": "info@acmeap.com",
- "trade_utility_consent": [
- {
- "business_service": "GST_VALIDATION_EWAYBILL",
- "consent": true,
}, - {
- "business_service": "GST_VALIDATION_GSTR",
- "consent": true,
}
], - "error": [ ]
}Sets up client account owner data (without financings input) at the validation service, linked to a financier.
| sendEmail | boolean Default: false When sendEmail=true, consent-link email is sent. If sendEmail is omitted or set to false, consent-link email is not sent because default value is false. |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
| submitting_financial_institution_identification required | string (BicOrUuidIdentifier) <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]... Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". |
required | object (PartyIdentification) Specifies the identification of an organisation. |
Array of objects (ContactIdentification6) | |
Array of objects (TradeUtilityCredentialDetails1) |
{- "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
- "trade_utility_account_holder_identification": {
- "name": "Protean eGov Technologies Limited",
- "identifications": {
- "other": [
- {
- "identification": "33AVXPM6863B1Z0",
- "scheme_name": {
- "proprietary": "IN:GSTIN"
}, - "issuer": "Goods and Services Tax Network"
}
]
}
}, - "trade_utility_account_holder_contacts": [
- {
- "email_address": "info@acmeap.com"
}
], - "trade_utility_credential_requests": [
- {
- "business_service": "GST_VALIDATION_EWAYBILL"
}, - {
- "business_service": "GST_VALIDATION_EINVOICE"
}, - {
- "business_service": "GST_VALIDATION_GSTR"
}
]
}{- "account_identification": "123e4567-e89b-42d3-a456-426614174000"
}Edits client account owner data (without financings input) at the validation service, linked to a financier.
| account-identification required | string <uuid> Example: 456e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| sendEmail | boolean Default: false When sendEmail=true, consent-link email is sent. If sendEmail is omitted or set to false, consent-link email is not sent because default value is false. |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
| submitting_financial_institution_identification required | string (BicOrUuidIdentifier) <= 36 characters ^([a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab]... Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - 'Banking - Banking telecommunication messages - Business identifier code (BIC)'. OR a UUID v4 identifier - Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". |
required | object (PartyIdentification) Specifies the identification of an organisation. |
Array of objects (ContactIdentification6) | |
Array of objects (TradeUtilityCredentialDetails1) |
{- "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
- "trade_utility_account_holder_identification": {
- "name": "Protean eGov Technologies Limited",
- "identifications": {
- "other": [
- {
- "identification": "33AVXPM6863B1Z0",
- "scheme_name": {
- "proprietary": "IN:GSTIN"
}, - "issuer": "Goods and Services Tax Network"
}
]
}
}, - "trade_utility_credential_requests": [
- {
- "business_service": "GSTN_goods_and_services_tax_network"
}
]
}nullRetrieves client account owner setup data at the validation service.
| account-identification required | string <uuid> Example: 456e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
- "trade_utility_account_holder_identification": {
- "name": "Protean eGov Technologies Limited",
- "identifications": {
- "other": [
- {
- "identification": "33AVXPM6863B1Z0",
- "scheme_name": {
- "proprietary": "IN:GSTIN"
}, - "issuer": "Goods and Services Tax Network"
}
]
}
}, - "trade_utility_account_holder_contacts": [
- {
- "email_address": "info@acmeap.com"
}
], - "trade_utility_credential_requests": [ ],
- "account_identification": "019f64f8-a18b-437a-8ef3-d0b4fddfcbde",
- "account_setup_status": "COMP",
- "account_owner_consent_email_address": "info@acmeap.com",
- "trade_utility_consent": [
- {
- "business_service": "GST_VALIDATION_EWAYBILL",
- "consent": true,
}, - {
- "business_service": "GST_VALIDATION_GSTR",
- "consent": true,
}
], - "error": [ ]
}Deletes client account owner data (without financings input) at the validation service, linked to a financier.
| account-identification required | string <uuid> Example: 456e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
nullRetrieves client consent status at the validation service.
| account-identification required | string <uuid> Example: 456e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
- "trade_utility_account_holder_identification": {
- "name": "Protean eGov Technologies Limited",
- "identifications": {
- "other": [
- {
- "identification": "33AVXPM6863B1Z0",
- "scheme_name": {
- "proprietary": "IN:GSTIN"
}, - "issuer": "Goods and Services Tax Network"
}
]
}
}, - "trade_utility_account_holder_contacts": [
- {
- "email_address": "info@acmeap.com"
}
], - "trade_utility_credential_requests": [ ],
- "account_identification": "019f64f8-a18b-437a-8ef3-d0b4fddfcbde",
- "account_setup_status": "COMP",
- "account_owner_consent_email_address": "info@acmeap.com",
- "trade_utility_consent": [
- {
- "business_service": "GST_VALIDATION_EWAYBILL",
- "consent": true,
}, - {
- "business_service": "GST_VALIDATION_GSTR",
- "consent": true,
}
], - "error": [ ]
}Generate client consent link at the validation service.
| account-identification required | string <uuid> Example: 456e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| X-UserContext | string Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIiLCJuYW1lIjoiIiwiaWF0IjowfQ.u_kftAUkjiUZO-OhIyj24H7lOUk1wi9GUF- Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer. |
{- "submitting_financial_institution_identification": "8e6705f0-8d24-4274-a6fe-e2961fbc82a1",
- "trade_utility_account_holder_identification": {
- "name": "Protean eGov Technologies Limited",
- "identifications": {
- "other": [
- {
- "identification": "33AVXPM6863B1Z0",
- "scheme_name": {
- "proprietary": "IN:GSTIN"
}, - "issuer": "Goods and Services Tax Network"
}
]
}
}, - "trade_utility_account_holder_contacts": [
- {
- "email_address": "info@acmeap.com"
}
], - "trade_utility_credential_requests": [ ],
- "account_identification": "019f64f8-a18b-437a-8ef3-d0b4fddfcbde",
- "account_setup_status": "COMP",
- "account_owner_consent_email_address": "info@acmeap.com",
- "trade_utility_consent": [
- {
- "business_service": "GST_VALIDATION_EWAYBILL",
- "consent": true,
}, - {
- "business_service": "GST_VALIDATION_GSTR",
- "consent": true,
}
], - "error": [ ]
}Update client credentials
| account-identification required | string <uuid> Example: 456e4567-e89b-12d3-a456-426614174000 Note: Will be filled in by the server, not by the submitter. UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier). A UUID is 128 bits long, and can guarantee uniqueness across space and time. In its canonical textual representation, the 16 octets of a UUID are represented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens). For example:123e4567-e89b-12d3-a456-426614174000 Format - xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx" |
| x-api-key required | string API key provided by the server for authentication against specific endpoints that cannot be supported with Auth0. |
| business_service required | string (TradeUtilityServiceName) [ 1 .. 70 ] characters Enum: "LLI_VALIDATION" "GST_VALIDATION_GSTR" "GST_VALIDATION_EWAYBILL" "GST_VALIDATION_EINVOICE"
|
| credentials_data | object Business service specific credentials |
| property name* additional property | any |
{- "business_service": "GSTN_goods_and_services_tax_network"
}null