Unified Add Customer API Example
This example is for creating a customer using API with the Manual KYC option where most of the parameters are applicable. For other KYC options, fewer parameters will be applicable.
Example Request
curl --location --request POST 'https://apisandbox.spend.nium.com/api/v4/client/{{clientHashId}}/customer/add' \
-H 'Content-Type: application/json' \
-H 'x-api-key: 0mZpIhaLVM1qd8IJhCfgjGJDsY7b5pdr00j' \
-H 'x-request-id: 123e4567-e89b-12d3-a456-426655440000' \
-H 'x-client-name: client1' \
-d '{
"firstName": "John",
"middleName": "Paul",
"lastName": "Smith",
"preferredName": "John",
"nativeLanguageName": "界限",
"email": "[email protected]",
"nationality": "SG",
"complianceLevel": "SCREENING_KYC",
"countryCode": "SG",
"mobile": "750609000",
"dateOfBirth": "1992-12-18",
"gender": "Male",
"customerType": "INDIVIDUAL",
"kycMode": "MANUAL_KYC",
"deliveryAddress1": "#20-05, Hong Leong Building",
"deliveryAddress2": "16 Raffles Quay",
"deliveryCity": "Singapore",
"deliveryLandmark": "Near Marina Blvd",
"deliveryState": "Singapore",
"deliveryZipCode": " 048581",
"deliveryCountry": "SG",
"billingAddress1": "#20-05, Hong Leong Building",
"billingAddress2": "16 Raffles Quay",
"billingCity": "Singapore",
"billingLandmark": "Near Marina Blvd",
"billingState": "Singapore",
"billingZipCode": "048581",
"billingCountry": "SG",
"correspondenceAddress1": "#20-05, Hong Leong Building",
"correspondenceAddress2": "16 Raffles Quay",
"correspondenceCity": "Singapore",
"correspondenceLandmark": "Near Marina blvd",
"correspondenceState": "Singapore",
"correspondenceZipCode": "048581",
"correspondenceCountry": "SG",
"deviceInfo": "android",
"ipAddress": "1.1.1.1",
"countryIP": "2.2.2.2",
"sessionId": "1234",
"segment": "gold",
"identificationDoc": [
{
"identificationType": "SelfieWithId",
"identificationDocument": [
{
"fileName": "selfieWithID.png",
"fileType": "image/png",
"document": "iVBORw0KGgoAAAANSUhEU...<Base64 Encoded Document>"
}
]
},
{
"identificationType": "Passport",
"identificationValue": "P12345",
"identificationIssuingAuthority": "Govt of Singapore",
"identificationIssuingDate": "05/05/2006",
"identificationDocExpiry": "04/05/2026",
"identificationDocHolderName": "John Paul Smith",
"identificationDocIssuanceCountry": "Singapore",
"identificationDocument": [
{
"fileName": "passport-front.jpg",
"fileType": "image/jpeg",
"document": "iVBORw0KGgoAAAANSUhEU...<Base64 Encoded Document>"
},
{
"fileName": "passport-back.jpg",
"fileType": "image/jpeg",
"document": "iVBORw0KGgoAAAANSUhEU...<Base64 Encoded Document>"
}
]
},
{
"identificationType": "UtilityBill",
"identificationIssuingAuthority": "XYZ Power Co",
"identificationIssuingDate": "01/06/2020",
"identificationDocHolderName": "John Paul Smith",
"identificationDocIssuanceCountry": "Singapore",
"identificationDocReferenceNumber": "6543227",
"identificationDocument": [
{
"fileName": "electricityBill.png",
"fileType": "image/png",
"document": "iVBORw0KGgoAAAANSUhEU...<Base64 Encoded Document>"
}
]
}
],
"taxDetails": [
{
"countryOfResidence": "France",
"taxIdNumber": "FR123456"
},
{
"countryOfResidence": "Spain",
"taxIdNumber": "ES267392"
}
],
"pep": true,
"verificationConsent": true
}'
Example Response
{
"customerHashId": "41ef937a-1bba-4fdc-a481-f8e580b919cf",
"walletHashId": "7be0018f-4a78-4d74-a182-3fd03fdbbdc2",
"paymentIds": [
{
"currencyCode": "SGD",
"uniquePaymentId": "8850932461249",
"uniquePayerId": null
},
{
"currencyCode": "USD",
"uniquePaymentId": "8850942972744",
"uniquePayerId": null
},
{
"currencyCode": "EUR",
"uniquePaymentId": "INITIALIZED",
"uniquePayerId": null
}
]
}
Updated 6 days ago