Creating a customer and account

Modulr will usually create your business and accounts in our systems as part of the on-boarding process, and in many cases you will not need this section and can skip it. However if you are a Partner and use the API you will need to know how to create your own Customers and Accounts.

Customers

A Customer in Modulr represents a legal entity (business or individual) within the Modulr platform

We have two options to create Customers

  1. A regular customer that requires KYC information where the partner has to provide us with all the KYC information for all their end customers
  2. A lean customer for payment clearing model where Modulr can help create a Customer with limited information but the partner is obligated to complete the KYC checks.

A regular customer will require verification - if you can create a Customer, then you will have agreed with us how the verification process will occur. Modulr will not do the customer verification for partners planning to opt for creating customers as a part of the payment clearing Model.

The sections below will explain in details the various options to create a customer.

Creating a Regular Customer

The API enables multiple Customer endpoints, the first you will need to create a Customer is the Create a new Customer call.

You will need the following information to successfully create a customer:

  • An expected monthly spend - if you don't know this you will still need to enter an estimated value
  • An industry code (unless it is an individual)
  • Registered and Trading addresses (depending on the type of company)
  • The version of Modulr T&Cs agreed to, if applicable
  • Type of Company, which can be one of: 'LLC', 'PLC', 'SOLETRADER', 'OPARTNRSHP', 'LPARTNRSHP', 'LLP', 'INDIVIDUAL
  • Name of the company (unless it is an individual)
  • Company registration number, if applicable
  • Details of any Associates - usually the Directors or Partners
  • Details of any uploaded documents, such as proof of a Director's identity**
  • The legal entity of the customer

🚧

Charities

Charity onboarding requires additional checks and therefore this API cannot be used to set up charities unless pre-approved by Modulr

📘

Legal Entity Flag

The legal entity flag can be set to either GB or IE, based on the location of the customer.

“GB” to identify customers based outside of the EEA (So UK (GB), Isle of Man (IM), Guernsey (GG), Jersey (JE) and Gibraltar (GI).

“IE” to identify customers based in the EEA.

In the success response you will receive a Customer ID, e.g. '12345678', which you will need for future interaction with the Customer object you just created. More detailed information can be found in the reference documentation.

** You will need to upload these documents only if you have outsourced your KYC to us. We have enabled via another endpoint (/documents). You'll need the raw content of the file, the file name and the 'group' - which is a combination of your 'Partner' business name and the name of the Customer that these documents are for.

Example of a request to upload a document:

{
"content":"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCAIGBBcDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD7suPjp4Xt/HN74ffWNJtYNNXGo3t7qMMPkzfwQoj/AH3/AL/9yvQLeeK6hSWKVJ4Jk3o6PvR0rlk+HOl2/jOXxFbKtvLfR7dRtvLR4bt8/JM/HyMn99Pvfx11kcflpsT5EqyylPrFvBMn72F0f5H+f7lXZJEhR5XfYipvd/8AYqGexindN/3E/g2ffqaT94jo/wA6P99KAPJL740+ILXTtI1q38ETahoWsSpDY/Yrh5rzY/3LmaFE2JDs+f79eqahBFPPZW8qLNC93sdH+43yPXD2PwlexWzsP+Em1VvDNlMk1voaoiKuxt6QvMnzvEn9yu4v50hmsriX5IIrje7/ANz5HoA4nxr8TvAngLxrpXhrVYNKt9QvlheOOZURz503kpsTZ8/z11XieXRPD0Vr5uiW073cwiULDEij/eZvlriPH3wX+G/xM8c6V4t1x5Jta0zyVgeK7eFP3UnmJvT/AH67nxFLofiXTzaXeqvDbP8A61IX2+av91/l6VHvHFD2/NPn/wC3SvJrngqOS4R4tN8yCTyZFW13Nv54+7833H/74qxNqfgyH7NvXSR9o/1OYU+f7/8As/7D/wDfFYdp4R8JWM73FpdvYzmf7SktswVoXO/ftfb9xt7/AH6mtfCvg+F3DXstymWRIZrl3REdHQon+x++f86C/wB6dHo9v4a160+1afZ6fcwbtvmJbp97/vmsvUtS8N6Do+mX+qabYww3pRN62qMivsd/T/Yqfwx/wj3g3SRY6fdqIA2/DL/8StK02gTWNha3F8r/AGNfkdS6f8s3T/0B3oNPe5TG/wCE48BLdzwvb2sflNMjyvY/ukEMaO7b9uNux05rUtdY8GXsyQwxafJJMu9VW06fPs+f5Pk+fj5qw9Y8J+HL7S7m0tdVmsmmV0WTzHfZvREf/wBAT/gdXI9D8OxXUd3HrN0LyFX23JuPn3P993+X/wCwoM/3hZ1LWfCej20t1qGn21pbo7p9oa0R/uOiD7vzfffYtVrjxV4AtGv4ZH00vYukdxGtqXfex4RF2fP/AMA+7S6toPh3W9FvdKu9UZLS4t4bU+T8jqin/d/iasSD4Z+B7G6vr6wv7jT7u4lW6S5tZdk1u/8AG6Ps3/Pvffv3/foNzpbrxF4Ds1geV9JQXDokX+jp8+93Qfwf30f/AL4qt/wmHw+/sOfVy+l/2dHP9mab7MOZc4VB8vzbuNv97PGao2HgfwXp+rT6iL6eaSSTzFhmu3dIvnmbYif3d003/fdReGfh74L8L6fa2NjeSQWtvcJcxQI2xFdNgT7iruC7AtAFyPx98OJ4LeeG80d4Li4+yxSLbcO+Ef8Aufc2vH8/3PnWls/HfgK+8UXOhxQ6e91bxbnm+yp5Jb5/lR8fMf3L/wDfFUpfAfgxooUivri0RYktnENwyfaLZYUh8l/76OkKVWk+F/glpp5U1XUoJZDsikgvnT7Im5/kh/uJ++m/77/3KAE1L4qeAdL0+6uzYRzyrN5UFrDZpI9zl0RHTb/A7unzvWxY+MvAU919jA0sX627XLW0cCOURF3nO1PvbPn2dabp/gzwTpalbedkQmEjNw/8EyTJ/wCPqlVbjwD4Hn0mfT4724gild5N8N2+9X8nyd//AHxVEe+W4PHXw5mlhiS70jzJrf7VH/o4TMex3/u/KcJJ8h+b5W4q/pviTwNrWpW1haLp8t9NEJ0t5LTY+z/gSff/ANj71c9a/DL4fWvh+PSEkZ7NH37PtDr8+yZN/wAn/XZ6mtfAvhKz8QHXRqdxPq4hWGa9mmTz5tn8bvs379nyfJ/BUlmhD4y8A3NzDAs2mPPcTG3iC2pG5vMCf3PuF2Rd/wB1s03RfHXw58Q3wstNn0e5umDNsS3H8Cb/AO7/AHPm/wB2s23+H/hG1az3axqEsdqY0SFrt3jeFH3w27fJ80KP9yr/APwi/hGOG2SK8eH7MiIj+c7/ACJD5P8A6A7pQBatfFXg66v5rJdPtEu4bT7bNA9qm9I9m+rLat4WS4e3k021V4bfz5f9FRvK+4uz/f8AnqW8Xw3cS3EsctvBPcOj3DonzzIj/c/8cqjfaH4X1HzzJqNwUm3/ALtLl9ib5N77E/22oAsX2s+D7MIXtbF4Xl2NKlorInyb/wC7/cSnw6t4Rk+2h7Syie1laF1a1Qbvn2fJ8vzfhVa30XwtAwZbxnG0RLmVzsUQtF/6A9J/Y3hjkLqVwjI++L/SH/0d/wC+lAF+S88HQKHeHTUR4vOV/s6fMnr93/aqSxl8M6prE2mW2nWM08UXnO/2VNn3tlZkeh+E4b+C7+2sJ4VVE/fP/sP/AOyVf0xfDuk6hNdQX7FmTZseZ3RF37vk/wCB0Ab/APwjOkf9Aqx/8B0/wo/4RnSP+gVY/wDgOn+FRf8ACVaV/wA/sNH/AAlWlf8AP7DQBL/wjOkf9Aqx/wDAdP8ACj/hGdI/6BVj/wCA6f4VF/wlWlf8/sNH/CVaV/z+w0AS/wDCM6R/0CrH/wAB0/wo/wCEZ0j/AKBVj/4Dp/hUX/CVaV/z+w0f8JVpX/P7DQBL/wAIzpH/AECrH/wHT/Cj/hGdI/6BVj/4Dp/hUX/CVaV/z+w0f8JVpX/P7DQBL/wjOkf9Aqx/8B0/wo/4RnSP+gVY/wDgOn+FRf8ACVaV/wA/sNH/AAlWlf8AP7DQBL/wjOkf9Aqx/wDAdP8ACj/hGdI/6BVj/wCA6f4VF/wlWlf8/sNH/CVaV/z+w0AS/wDCM6R/0CrH/wAB0/wo/wCEZ0j/AKBVj/4Dp/hUX/CVaV/z+w0f8JVpX/P7DQBL/wAIzpH/AECrH/wHT/Cj/hGdI/6BVj/4Dp/hUX/CVaV/z+w0f8JVpX/P7DQBL/wjOkf9Aqx/8B0/wo/4RnSP+gVY/wDgOn+FRf8ACVaV/wA/sNH/AAlWlf8AP7DQBL/wjOkf9Aqx/wDAdP8ACj/hGdI/6BVj/wCA6f4VF/wlWlf8/sNH/CVaV/z+w0AS/wDCM6R/0CrH/wAB0/wo/wCEZ0j/AKBVj/4Dp/hUX/CVaV/z+w0f8JVpX/P7DSuBL/wjOkf9Aqx/8B0/wo/4RnSP+gVY/wDgOn+FRf8ACVaV/wA/sNH/AAlWlf8AP7DTAl/4RnSP+gVY/wDgOn+FH/CM6R/0CrH/AMB0/wAKi/4SrSv+f2Gj/hKtK/5/YaAJf+EZ0j/oFWP/AIDp/hR/wjOkf9Aqx/8AAdP8Ki/4SrSv+f2Gj/hKtK/5/YaAJf8AhGdI/wCgVY/+A6f4Uf8ACM6R/wBAqx/8B0/wqL/hKtK/5/YaP+Eq0r/n9hoAl/4RnSP+gVY/+A6f4Uf8IzpH/QKsf/AdP8Ki/wCEq0r/AJ/YaP8AhKtK/wCf2GgCX/hGdI/6BVj/AOA6f4Uf8IzpH/QKsf8AwHT/AAqL/hKtK/5/YaP+Eq0r/n9hoAl/4RnSP+gVY/8AgOn+FH/CM6R/0CrH/wAB0/wqL/hKtK/5/YaP+Eq0r/n9hoAl/wCEZ0j/AKBVj/4Dp/hR/wAIzpH/AECrH/wHT/Cov+Eq0r/n9ho/4SrSv+f2GgCX/hGdI/6BVj/4Dp/hR/wjOkf9Aqx/8B0/wqL/AISrSv8An9ho/wCEq0r/AJ/YaAJf+EZ0j/oFWP8A4Dp/hR/wjOkf9Aqx/wDAdP8ACov+Eq0r/n9ho/4SrSv+f2GgCX/hGdI/6BVj/wCA6f4Uf8IzpH/QKsf/AAHT/Cov+Eq0r/n9ho/4SrSv+f2GgCX/AIRnSP8AoFWP/gOn+FH/AAjOkf8AQKsf/AdP8Ki/4SrSv+f2Gj/hKtK/5/YaAJf+EZ0j/oFWP/gOn+FH/CM6R/0CrH/wHT/Cov8AhKtK/wCf2Gj/AISrSv8An9hoAl/4RnSP+gVY/wDgOn+FH/CM6R/0CrH/AMB0/wAKi/4SrSv+f2Gj/hKtK/5/YaAJf+EZ0j/oFWP/AIDp/hR/wjOkf9Aqx/8AAdP8Ki/4SrSv+f2Gj/hKtK/5/YaAJf8AhGdI/wCgVY/+A6f4Uf8ACM6R/wBAqx/8B0/wqL/hKtK/5/YaX/hKtK/5/UoAcPDelf8AQJsR/wBu6f4UHwzpP/QLsv8AwHT/AArhLz9oTwPbTSx22ry6rNG/lmPSbG5vRv8A7paGNlzWb/wv8Xzf8SzwT4nux6z2S2i/+RnS…xQBg/arf/nrD/33R9qt/wDnrD/33W95Cf3F/wC+Kp311HYtbYg3+bKsPyr92gDN+1W//PWH/vuj7Vb/APPWH/vupbjxJpVjNNBdTR2zxDc5dflqa31zS7i7+yx3MElzu2eWnWqKKn2q3/56w/8AfdH2q3/56w/990+HxLpskPm+ZFGiff3/AMFM/wCEs0ePbJNcxRL5SyMznhf876AD7Vb/APPWH/vuj7Vb/wDPWH/vurMmvaalrdXCTRTR23+t8tfu07+29O+xz3STRPDEju5Rf7n36AKn2q3/AOesP/fdH2q3/wCesP8A33TF8Vab/o/2grbeYu8O6/J03f8AstXrfXtJu3hWK7t5Xm+5t/ioAqfarf8A56w/991xPxG+Fvhn4ptZr4gurie2st729lDeeSkVz/Bc/J/y2T+B/wCCvTNy/bfL2Ls8vf8Ad968k+Knxk1bwp4nTw7oHhWTV9RgtF1a7kmdEh+wq+JtmW+/QB3tl5en2NvA1+L+WKFFe4uHTdNx99/9qinfD/xVa/EPwfpXiG3spbODUIRNFDcou9VoqSTp6KKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAK5r4kf8AIman/uV0tc18SP8AkTNT/wBygDxzwj/yGP8AgH/s6V7D4s8N2Hi+ziiuXvLO4tpPOtru0V0mgfpuT5a8e8Hf8hj/AIB/7Olex+J9Yu9KutKjtLN9QN3deTKsY+dE7uP4fl/2qrl5glLlMzwB4B0j4b2V5Dp8d01xfT/aLu4uAd0khxk/IoRf91AF/OuqTydsy4kdZW+b909XqKkDgb74f6PcJAkJ1C28qWJt6S3BcbNn3efk3bE+f/Yrr7JbXT7WG3t4njhiTYiBH+Vav0UAQfao/wDa/wC/T0fao/8Aa/79PU9FAFR5oJJEdkZ3T7reS/y0yZ4ptn+t+Rt/+qer1FAGHLbxTXiTtD5zo/mRb0f5Pk2f3KypvB2jzoif2fs2/c2TTV2NFAGNZqmn26wQW6JCpchPn/vbv7lW/tkv/PJf++X/APiKvUUAUftkv/PJf++X/wDiKPtkv/PJf++X/wDiKvUUAUftkv8AzyX/AL5f/wCIo+2S/wDPJf8Avl//AIir1FAFH7ZL/wA8l/75f/4ij7ZL/wA8l/75f/4ir1FAFH7ZL/zyX/vl/wD4ij7ZL/zyX/vl/wD4ir1FAGdNdSzLtCbPm/uv/wDEVDfafYalcWs9xFJJNbtvifY/y/Oj/wDsiVr0UAcpF4T0SCa1lht54vs/3URptjf3S6fx/crpPtcf/TX/AL9P/hU9FAEH2qP/AGv+/T0fao/9r/v09T0UAU0lgg37Fddzb22xPUv2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09H2qP8A2v8Av09T0UAQfao/9r/v09QTNb3OzzEZ9j70/dP96r1FAGJfaPpd8ztLFLvZ9/y70+apobGwhmSVInR0bf8Acf8A2/8A4t61aKAMKbRtLuOfImR0X5XTzUdai/4R3R/u/Z7jYPuf675P9yuiooAxpNLsJIpYjFKiSLtfYjp/FvqC30q0hkuQEleOaLydux/uf7//AANq6CigDDn0XSrhXRreQq/3/lf5v876VNK06PyP3Nx+6fen3/v1t0UAUfMi+0ebiX7uz/VPXnnxG+Cng/4manb6lqlpdQ6kjoHvLMukksKf8sX/ANht9eo0UAYfhzRdH8G6La6Ro9l/Z+mWibIraCF9qCityigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigArmviR/yJmp/7ldLXNfEj/kTNT/3KAPHPCP8AyGP+Af8As6V9EV87+Ef+Qx/wD/2dK+iKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigArmviR/wAiZqf+5XS1zXxI/wCRM1P/AHKAPHPCP/IY/wCAf+zpX0RXzv4R/wCQx/wD/wBnSvoigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAK5r4kf8iZqf8AuV0tc18SP+RM1P8A3KAPHPCP/IY/4B/7OlfRFfO/hH/kMf8AAP8A2dK+iKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigArmviR/yJmp/7ldLXNfEj/kTNT/3KAPHPCP/ACGP+Af+zpX0RXzv4R/5DH/AP/Z0r6IoAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACua+JH/Iman/uV0tc18SP+RM1P/coA8c8I/wDIY/4B/wCzpX0RXzv4R/5DH/AP/Z0r6IoAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACua+JH/ACJmp/7ldLXNfEj/AJEzU/8AcoA8c8I/8hj/AIB/7OlfRFfO/hH/AJDH/AP/AGdK+iKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigArmviR/yJmp/wC5RRQB454R/wCQx/wD/wBnSvoiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooA//Z",
"fileName":"Example File 1.jpg",
"group":"MODULR CLEGG CONSULTING LTD"
}

If successful, we will respond with a "path" and 'fileName'. Use these when creating the CUSTOMER in your next call. Here is an example:

{
"path": "MODULR+CLEGG+CONSULTING+LTD%2F20171025143744_Example+File+1.jpg",
"fileName": "Example File 1.jpg"
}

Linking the documents to the Customer

In order to link a document you have uploaded to a Customer, include the "documentInfo" parameter in your API call when creating the Customer and reference the appropriate "path" and "fileName". You can include multiple documents in the array that way.

NB: documentInfo can be attached to different objects. It can be attached to a CUSTOMER or it can be attached to ASSOCIATE. For example, if documents relate to a limited company then documents should be attached to CUSTOMER level. If documents relate to an Ultimate Beneficial Owner of the company then documents should be attached to the ASSOCIATE within the CUSTOMER.

NB: If there are no documents to upload, then don't include documentInfo parameter in the call.

Creating a Customer for Payment Clearing Model

Payments Clearing Model applies to EMI regulated Partners who wish to complete KYC/KYB for their end customers and not share that data with Modulr. A business (Partner) registering with Modulr to use this service can create Customer accounts with limited customer information.

Payments Clearing Model APIs will allow partners to request EMI accounts for customer types listed below:

  • PCM Individual users
  • PCM Business users

To request the creation of Account for PCM Individual, Modulr would need the customer details as listed below:

A. Mandatory

  • First and Last Names
  • Home Address
  • Legal Entity

📘

Legal Entity Flag

When creating customers, PCM Partners should set the legal entity flag to reflect which Modulr Legal entity they are contracted with i.e. “GB” for Modulr FS Limited and “IE” for Modulr FS Europe Limited.

B. Optional

  • External reference - ideally the unique customer reference that a Partner holds in their system for this end-user.

To request the creation of account for customers for PCM Business , Modulr would need the customer details as listed below:

A. Mandatory

  • Business Name for the End Customer
  • Trading Address
  • Legal Entity

B. Optional

  • External reference - ideally the unique customer reference that a Partner holds in their system for this end-user.

Accounts

Once you have created a regular Customer you will need to provide them with an Account so they can make and receive payments. We've made this very easy.

Product Codes

A Partner has certain product codes given to it, which enables the accounts of it and its customers to be used for the relative scheme/currency of that product. For example, for EUR based accounts to be available, the Partner must have the relevant EUR product. On creation of a new account the product or products need to be added.

You will need the Customer ID you received when you created the Customer and to use the endpoint for creating an account.

Example:

curl --request POST \
  --url https://api-sandbox.modulrfinance.com/api-sandbox/customers/1234567/accounts \
  --data '{"currency":"GBP","externalReference":"this","productCode":"1"}'

Once again you will be given an ID for the Account, which you will need for further interaction with the account in the platform.

You will also receive an account number and sort code, which allows paying in to the account, although on Sandbox you should use the simulated 'pay in' endpoint to fund with 'play money'.


Did this page help you?