Perform a Know Your Customer (KYC) check on a consumer customer. The response may indicate that more details are required in which case subsequent calls with the additional details can be made. See Know Your Customer for more details.
Alpha release - Consider this endpoint experimental and very likely to change in future.
required | object (KycConsumerCustomer1) |
{- "KycConsumerCustomer": {
- "emailAddress": "lucy.diamond@star.com",
- "phoneNumber": "+61401234567",
- "ipAddress": "string",
- "customerIdentification": {
- "name": {
- "givenName": "string",
- "middleName": "string",
- "familyName": "string"
}, - "dateOfBirth": "2019-08-24",
- "address": {
- "address": "string",
- "componentised": {
- "unitNumber": "string",
- "streetNumber": "string",
- "streetName": "string",
- "streetType": "string",
- "suburb": "string",
- "city": "string",
- "postcode": "string",
- "state": "string",
- "country": "string"
}, - "addressIdentifier": "string"
}, - "driversLicence": {
- "number": "string",
- "state": "string",
- "documentNumber": "string"
}, - "passport": {
- "number": "string",
- "country": "string"
}, - "driversLicenceWithVersion": {
- "number": "string",
- "versionNumber": "string"
}, - "passportWithExpiry": {
- "number": "string",
- "expiryDate": "string"
}
}, - "isCustomerVerified": true,
- "referenceCustomerId": "string"
}
}
{- "ConsumerCustomerKycResult": {
- "payTypeEligibility": {
- "eligibility": "allow",
- "idDocOptions": [
- {
- "idDocType": "driverslicence",
- "idDocTypes": [
- "driverslicence"
], - "remainingAttempts": 0
}
], - "message": "string"
}
}
}