Afinis Bank Contact V2 API

{"swagger":"2.0","info":{"description":"Afinis is a diverse group of organizations working to support advancement and use of API standardization in the financial services industry. Utilization of this API requires a developer to [register](https://www.afinis.org/user/register) their application.","version":"1.0.9","title":"Bank Contact V2","contact":{"email":"info@afinis.org","url":"https://www.afinis.org"}},"host":"api.afinis.org","basePath":"/ASIG/Bank_Contact_v2/1.0.5","securityDefinitions":{"APIKeyQueryParam":{"type":"apiKey","in":"query","name":"apikey"}},"consumes":["application/json"],"produces":["application/json"],"schemes":["https"],"paths":{"/banks/contact":{"post":{"operationId":"Expand Bank Contact V2 - Input","tags":["Expand Bank Contact V2"],"summary":"Allow a FI to input data into the FI contact data base","description":"Expand Get Bank Contact","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"bankContacts","required":false,"description":"Allow a FI to input data into the FI contact data base","schema":{"type":"object","required":["agent","bankContact"],"properties":{"agent":{"$ref":"#/definitions/agent"},"additionalInformation":{"type":"string","description":"Any message the FI wishes to have go to anyone who pulls any contact","maxLength":128,"example":"The Department contact number is 703 561 0000 option 1, option 3, option 3"},"bankContact":{"type":"array","items":{"$ref":"#/definitions/bankContact"}}}}}],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/response"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/badRequest"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/unauthorized"}},"403":{"description":"Access denied, the operation is not allowed"},"404":{"description":"Not Found"},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/internalServerError"}},"503":{"description":"Service unavailable"}},"security":[{"APIKeyQueryParam":[]}]},"get":{"operationId":"Expand Bank Contact V2 - Get","tags":["Expand Bank Contact V2"],"summary":"Allow a FI to retrieve data from the FI contact data base","description":"Expand Get Bank Contact","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"memberIdentification","in":"query","required":true,"type":"string","description":"Identification of a member of a clearing system  e.g., a U.S. transit routing number or Canadian Payments Association Routing Number"},{"name":"contactCategory","in":"query","required":true,"type":"string","description":"Contact Category","enum":["ACH Operations","ACH Fraud","Wire","Check","Credit Card","Debit Card","Compliance","Anti-Money Laundering","Legal","LOI Processing","Faster Payments","Treasury Management"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/response"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/badRequest"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/unauthorized"}},"403":{"description":"Access denied, the operation is not allowed"},"404":{"description":"Not Found"},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/internalServerError"}},"503":{"description":"Service unavailable"}},"security":[{"APIKeyQueryParam":[]}]}}},"definitions":{"bankContact":{"title":"Bank Contact","type":"object","properties":{"contactType":{"$ref":"#/definitions/contactType"},"contactCategory":{"type":"string","description":"Area of FI","maxLength":70,"example":"ACH Operations","enum":["All","ACH Operations","ACH Fraud","Wire","Check","Credit Card","Debit Card","Compliance","Anti-Money Laundering","Legal","LOI Processing","Faster Payments","Treasury Management"]},"partyType":{"$ref":"#/definitions/partyType"},"identification":{"type":"string","description":"Identification returned in input information response","maxLength":35,"example":"84e232cc-12c8-4266-bcc1-9de2a1ca448c"},"loginAccess":{"type":"string","example":true,"enum":[true,false]},"contactDetails":{"type":"array","items":{"$ref":"#/definitions/contactDetails"}}}},"agent":{"title":"Agent","description":"Identification of a financial institution.","type":"object","required":["clearingSystemIdentification","memberIdentification"],"properties":{"clearingSystemIdentification":{"type":"string","example":"USABA","enum":["USABA"],"description":"Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed: \n * `USABA` - Routing Transit number assigned by the ABA for US financial Institutions. \n"},"memberIdentification":{"type":"string","maxLength":35,"example":"061103852"}}},"contactType":{"type":"string","example":"Primary","enum":["Primary","Secondary","Other"]},"partyType":{"type":"string","example":"Individual","enum":["Individual","Department"]},"contactDetails":{"type":"object","required":["emailAddress","phoneNumber"],"properties":{"phoneNumber":{"type":"string","maxLength":30,"example":"+1-302-515-5000"},"faxNumber":{"type":"string","maxLength":30,"example":"+1-302-515-6000"},"emailAddress":{"type":"string","maxLength":2048,"example":"zachary.eastwood@ABCcorp.com"},"jobTitle":{"type":"string","maxLength":35,"example":"Accounts Receive Specialist"},"other":{"type":"array","items":{"$ref":"#/definitions/other"}}}},"other":{"type":"object","required":["channelType","identification"],"properties":{"channelType":{"type":"string","example":"EXT","enum":["EXT"],"description":"Name of the identification scheme:\n   * `FNM` - First Name\n   * `LNM` - Last Name\n   * `DNM` - Department Name\n   * `BH` - Business Hours\n   * `TZ` - Time Zone\n   * `EXT` - Phone Number Extension\n"},"identification":{"type":"string","maxLength":128,"example":"Ext 1"}}},"response":{"title":"Response","type":"object","description":"200 - Response","required":["bankContact"],"properties":{"agent":{"$ref":"#/definitions/agent"},"additionalInformation":{"type":"string","description":"Any message the FI wishes to have go to anyone who pulls any contact","maxLength":128,"example":"The Department contact number is 703 561 0000 option 1, option 3, option 3"},"bankContact":{"type":"array","items":{"$ref":"#/definitions/bankContact"}}}},"badRequest":{"title":"Bad Request","type":"object","description":"400 - Bad Request","required":["details"],"properties":{"details":{"description":"error details","type":"array","items":{"$ref":"#/definitions/badRequestErrorDetails"}}}},"badRequestErrorDetails":{"title":"Bad Request Error Details","type":"object","required":["errorCode","message"],"properties":{"errorCode":{"description":"A programmatic error code:\n  * `2000` - Invalid JSON structure.\n  * `2001` - '[Field name] is missing or invalid.'\n  * `2002` - Invalid date.\n  * `2003` - Invalid combination of fields submitted. Check the API specification for eligible combinations. \n  * `2004` - '[Field name] cannot be more than [max number] characters.'\n","example":2000,"type":"number","enum":[2000,2001,2002,2003,2004]},"message":{"description":"A human readable description of the problem","example":"Invalid JSON structure.","type":"string"}}},"unauthorized":{"title":"Unauthorized","type":"object","description":"401 - Unauthorized","required":["details"],"properties":{"details":{"description":"error details","type":"array","items":{"$ref":"#/definitions/unauthorizedErrorDetails"}}}},"unauthorizedErrorDetails":{"title":"Unauthorized Error Details","type":"object","required":["errorCode","message"],"properties":{"errorCode":{"example":1000,"type":"number","enum":[1000,1001],"description":"A programmatic error code:\n  * `1000` - API key is missing, invalid or expired. \n  * `1001` - API token is invalid, expired, or account associated with key does not have access to that API.\n"},"message":{"description":"A human readable description of the problem","example":"API key is missing, invalid or expired.","type":"string"}}},"internalServerError":{"title":"Internal Server Error","description":"500 - Internal Server Error","type":"object","required":["details"],"properties":{"detail":{"description":"error details","type":"array","items":{"$ref":"#/definitions/internalServerErrorDetails"}}}},"internalServerErrorDetails":{"title":"Internal Server Error Details","type":"object","required":["errorCode","message"],"properties":{"errorCode":{"example":3001,"type":"number","enum":[3001],"description":"A programmatic error code:\n  * `3001` - Internal Server error.\n"},"message":{"description":"A human readable description of the problem","example":"Internal Server error","type":"string"}}}}}