{"swagger":"2.0","info":{"description":"Preliminary API specification","version":"1.0.0","title":"10x Mobile API","contact":{"email":"gabor.kajtar@uicentric.com"}},"host":"test.com","basePath":"/v1","schemes":["https"],"paths":{"/registration/start":{"post":{"tags":["on-boarding"],"summary":"Start verification process.","description":"","operationId":"","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Email verification body","required":true,"schema":{"$ref":"#/definitions/VerifyEmailRequest"}}],"responses":{"200":{"description":"Successful response that contains the ","schema":{"$ref":"#/definitions/VerifyEmailResponse"}},"409":{"description":"email address already exists."}}}},"/registration/phones/verification/send":{"post":{"tags":["on-boarding"],"summary":"Send verification code to phone number.","description":"","operationId":"","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/VerifyPhoneStartRequest"}},{"name":"authorization","in":"header","required":true,"description":"Token returned by /registration/start request.","type":"string"}],"responses":{"200":{"description":"Successful response.","schema":{"$ref":"#/definitions/VerificationResponse"}},"409":{"description":"Phone number is already used."}}}},"/registration/phones/verification/verify":{"post":{"tags":["on-boarding"],"summary":"Verify phone verification code.","description":"","operationId":"","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone number","required":true,"schema":{"$ref":"#/definitions/VerifyPhoneCodeRequest"}},{"name":"authorization","in":"header","required":true,"description":"Token returned by /registration/start request.","type":"string"}],"responses":{"200":{"description":"Successful response.","schema":{"$ref":"#/definitions/VerificationResponse"}},"403":{"description":"Incorrect verification code"}}}},"/registration/postcodes/{postcode}":{"get":{"tags":["on-boarding"],"summary":"Get addresses for UK postcode.","description":"","operationId":"","produces":["application/json"],"parameters":[{"in":"path","name":"postcode","type":"string","description":"UK Postcode","required":true}],"responses":{"200":{"description":"Successful response.","schema":{"type":"array","items":{"$ref":"#/definitions/Address"}}},"404":{"description":"No address found for the specified postcode."}}}},"/register":{"post":{"tags":["on-boarding"],"summary":"Register user","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User info","required":true,"schema":{"$ref":"#/definitions/User"}},{"name":"authorization","in":"header","required":true,"description":"Token returned by /registration/start request.","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserRegistrationResponse"}},"400":{"description":"User registration failure."}}}},"/transactions":{"get":{"tags":["ledger"],"summary":"List transactions","description":"","operationId":"","produces":["application/json"],"parameters":[{"name":"offset","in":"query","description":"Limit the results to a particular record count.","required":false,"type":"integer"},{"name":"limit","in":"query","description":"Maximum number of items in the response.","required":false,"type":"integer"},{"name":"date","in":"query","description":"Filter response by date.","required":false,"type":"string","format":"date"},{"name":"authorization","in":"header","required":true,"type":"string"}],"responses":{"200":{"description":"List of transaction.","schema":{"$ref":"#/definitions/TransactionsResponse"}}}}},"/transactions/{id}":{"get":{"tags":["ledger"],"summary":"Transaction details","description":"","operationId":"","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Transaction id.","required":true,"type":"string"},{"name":"authorization","in":"header","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction details","schema":{"$ref":"#/definitions/Transaction"}},"404":{"description":"Transaction not found."}}}},"/contacts/search":{"get":{"tags":["payments"],"summary":"Search for a VEBO contact","description":"","operationId":"","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"email","in":"query","description":"Email of VEBO contact","required":false,"type":"string"},{"name":"phone","in":"query","description":"Phone number of VEBO contact","required":false,"type":"string"},{"name":"authorization","in":"header","required":true,"type":"string"}],"responses":{"200":{"description":"Contact exists.","schema":{"$ref":"#/definitions/Contact"}},"404":{"description":"Contact not found."},"400":{"description":"Either the email or the phone parameters must be provided."}}}},"/accounts/verify":{"post":{"tags":["payments"],"summary":"Verify account","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Account info","required":true,"schema":{"$ref":"#/definitions/VerifyAccountRequest"}},{"name":"authorization","in":"header","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/VerificationResponse"}},"404":{"description":"Account not found"}}}},"/payments/bank":{"post":{"tags":["payments"],"summary":"Pay an account number and sort code","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"","required":true,"schema":{"$ref":"#/definitions/BankPaymentRequest"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"404":{"description":"Payment was unsuccessful."}}}},"/payments/contact":{"post":{"tags":["payments"],"summary":"Pay a contact","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"","required":true,"schema":{"$ref":"#/definitions/ContactPaymentRequest"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"404":{"description":"Payment was unsuccessful."}}}}},"definitions":{"VerifyEmailRequest":{"type":"object","properties":{"email":{"type":"string"}}},"VerifyEmailResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"true if verified; otherwise false"},"token":{"type":"string","description":"JWT Token to send with every on-boarding request"}}},"VerifyPhoneStartRequest":{"type":"object","properties":{"phone":{"type":"string","example":"+447833441412"}}},"VerifyPhoneCodeRequest":{"type":"object","properties":{"code":{"type":"string","example":"236243"}}},"Address":{"type":"object","properties":{"houseNo":{"type":"string","example":"Flat 12"},"addressLine1":{"type":"string","example":"16 Cornwall Gardens"},"addressLine2":{"type":"string"},"city":{"type":"string","example":"London"},"county":{"type":"string"},"postcode":{"type":"string","example":"SW7 4AN"}}},"User":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"houseNo":{"type":"string","example":"Flat 12"},"addressLine1":{"type":"string","example":"16 Cornwall Gardens"},"addressLine2":{"type":"string"},"city":{"type":"string","example":"London"},"county":{"type":"string"},"postcode":{"type":"string","example":"SW7 4AN"},"citizenshipCountries":{"type":"array","items":{"type":"string","example":"fr"}},"taxCountries":{"type":"array","items":{"type":"string","example":"uk"}},"bankAccount":{"$ref":"#/definitions/BankAccount"}}},"BankAccount":{"type":"object","properties":{"sortCode":{"type":"string"},"accountNumber":{"type":"string"}}},"UserRegistrationResponse":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"token":{"type":"string"}}},"TransactionListItem":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"integer","description":"Transaction Date / Time in epoch","example":1524494275},"title":{"type":"string","example":"Tesco"},"amount":{"type":"number","example":43.5},"direction":{"type":"string","description":"Direction of transaction","enum":["in","out"]}}},"Transaction":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"integer","description":"Transaction Date / Time in epoch","example":1524494275},"title":{"type":"string","example":"Tesco"},"contact":{"$ref":"#/definitions/Contact"},"amount":{"type":"number","example":43.5},"direction":{"type":"string","description":"Direction of transaction","enum":["in","out"]},"reference":{"type":"string","description":"Payment reference"},"method":{"type":"string","description":"Payment method","enum":["chip_and_pin","vebo","account_transfer","cash_withdrawal"]}}},"TransactionsResponse":{"type":"object","properties":{"total":{"description":"Total number of items","example":134,"type":"integer"},"items":{"type":"array","description":"List of transaction.","items":{"$ref":"#/definitions/TransactionListItem"}}}},"Contact":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"profileImageUrl":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"type":{"type":"string","description":"Contact type","enum":["vebo","account"]}}},"VerifyAccountRequest":{"type":"object","properties":{"accountNumber":{"type":"string","format":"string"},"sortCode":{"type":"string","format":"string"}}},"BankPaymentRequest":{"type":"object","properties":{"accountNumber":{"type":"string"},"sortCode":{"type":"string"},"amount":{"type":"number"},"reference":{"type":"string"}}},"ContactPaymentRequest":{"type":"object","properties":{"contactId":{"type":"string"},"amount":{"type":"number"},"reference":{"type":"string"}}},"VerificationResponse":{"type":"object","properties":{"success":{"type":"boolean"}}}}}