Manage country data specifics for Sis ID checks and other APIs
Useful information for international dataset management is available in dedicated sections of this help center : Company identifiers and bank details formats supported by geography
Two approaches observed by Sis ID
From the ecosystem of integrated software vendors, Sis ID observes two approaches:
Approach 1: Replicate Sis ID coverage and specifics on the integration side.
- In this approach, the API consumer must manage on its side the list of available countries and the format accepted for each of these countries.
💡To test out regular expression, you may like to use a tool like https://regex101.com/
Approach 2: Ignore Sis ID coverage and specifics on the integration side.
- In this approach, the API consumer send all requests to Sis ID regardless of the capacity of Sis ID to proceed it. The API consumer anticipates it is likely to receive 400 - Bad Request type errors as follows:
{ "message": "error.illegalState", "description": "Country code [UU] is not a valid country code!", "httpStatus": "BAD_REQUEST", "moreInformation": "Country code [UU] is not a valid country code!", "httpCode": "400", "httpMessage": "Bad Request" }{ "message": "error.illegalState", "description": "Country [SG] does not support the registration id [824003958]!", "httpStatus": "BAD_REQUEST", "moreInformation": "Country [SG] does not support the registration id [824003958]!", "httpCode": "400", "httpMessage": "Bad Request" }{ "message": "error.illegalState", "description": "Country [TF] is not supported yet!", "httpStatus": "BAD_REQUEST", "moreInformation": "Country [TF] is not supported yet!", "httpCode": "400", "httpMessage": "Bad Request" }{ "message": "error.validation", "fieldErrors": [ { "objectName": "entity", "field": "paymentIdentity.iban", "message": "size must be between 14 and 34" } ], "httpStatus": "BAD_REQUEST", "httpCode": "400", "httpMessage": "Bad Request" }
Know more about error messages in What API response may be encountered for error cases?
Comparison between the approaches
You can find below a short comparison of the integration approaches to guide you in your implementation of Sis Inside APIs:
| Pros | Cons | |
| Approach 1 | End user experience is better | API consumer must stick to Sis ID specifics and update when a country is added or edited |
| Approach 2 | Limited effort from an integration perspective | Error handling and associated end user experience must be adjusted accordingly |