This second step allow LinkCy to verify that the phone number and country code provided by the consumer is valid and he controls the SIM.
If the consumer does not provide a valid code, he will not get access to the KYC step which is also mandatory.
The SMS code is a 6-digits and valid for 10 minutes and the consumer has 5 attempts. Once the delay of the number of attempts is reached, you have to ask for another code by using: Send consumer verification code Endpoint here.
Note: You can simulate that step in a Sandbox environment. Code is always 123456.
Phone was successfully verified
Bad Request
Unauthorized
Forbidden
Conflict
{- "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
- "code": "string"
}
{- "details": [
- {
- "field": "{path.to.field}",
- "rejectedValue": "{rejectedValue}",
- "message": "Phone code is not valid."
}
], - "errorCode": "INVALID_PHONE_CODE",
- "error": "linkcy.bad.request",
- "status": 400,
- "timestamp": "2024-11-14T16:14:59.841341744Z"
}
This Endpoint allows you to send a verification code to your user by SMS. This code is a 6-digit code.
If you want to personalize the Sender Name, please contact your customer care.
NOTE : In Sandbox, no SMS is sent. Verification code will always be 123456
Message sent
Bad Request
Unauthorized
Forbidden
Conflict
{- "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e"
}
{- "ttl": "PT10M"
}
This Endpoint allows you to send an email verification to your user. The user will receive a link by email in order to verify his current email.
Verification email sent
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
{- "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
- "emailSubject": "[{partnerName}] Please verify your email",
}
{- "ttl": "PT48H"
}
This endpoint allows you to verify an end-user's address using different methods:
LINK: This method generates a URL link that the end-user can use to complete its Proof of Address (POA).
UPLOADED_DOCUMENT: Use this method when a POA document has already been uploaded which will be used to verify the address.
DELEGATED: When the address verification is delegated to the partner (property "delegatedPoa" set to "true") and the POA document has been uploaded, you can use this method to update the address status to "VERIFIED".
OK
Bad Request
Unauthorized
Forbidden
Conflict
{- "type": "LINK",
- "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5"
}
{- "url": "string",
- "ttl": "string"
}
Fetch all KYC applications based on parameters. More options will be added in the near future.
OK
Bad Request
Unauthorized
Forbidden
{- "content": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
- "personType": "CONSUMER",
- "address": {
- "isoCountryCode": "ABW",
- "city": "string",
- "postalCode": "string",
- "street": "string",
- "number": "string",
- "refinement": "string",
- "stateOrProvince": "string",
- "status": "INVALID"
}, - "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "gender": "MALE",
- "birthDate": "2019-08-24",
- "emailAddress": "string",
- "birthCity": "string",
- "birthIsoCountryCode": "ABW",
- "status": "NOT_STARTED",
- "statusReason": "string",
- "creationDate": "2019-08-24T14:15:22Z",
- "updateDate": "2019-08-24T14:15:22Z"
}
], - "totalElements": 1,
- "page": 0,
- "pageSize": 0
}
Physical users need to complete a due diligence (KYC), this step is mandatory to be able to use banking features. Due diligence is performed with the local language of your users.
Once the field "phoneValidated" is in "true" state, you will be able to request a KYC for you consumer by link, SDK or if the KYC is delegated, you can directly provide us the results.
BY LINK:
The link is valid for 720H. Do not ask for multiple links, this can delay the onboarding of the consumer and trigger security thresholds on our side.
By default, for performance reasons related to pictures, we oblige the consumer to do the KYC on a mobile phone, if you want to allow them to use the computer, please ask your consumer care.
For a fully embedded experience, we suggest you provide us with a success and a failure URL.
BY SDK:
We will provide you a SDK token valid for 24H that will allow one your user to perform its KYC via SDK. Do not hesitate to contact us for more information.
Note: We do not allow consumers to download pictures from the gallery.
Delegated to partner:
When the partner configuration is set with field "delegatedKyc" to "true", you can directly provide us the data of the KYC already performed by the user in the request payload.
Note: before sending a delegated KYC, you must have previously uploaded the KYC Summary and the identity document of the user using the document create API endpoint.
KYC successfully created
Bad Request
Unauthorized
Forbidden
Conflict
{- "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
- "kycConfiguration": {
- "accessType": "LINK",
}
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "token": "string",
- "kycApiUrl": "string",
- "flowName": "string",
- "ttl": "PT8H6M12.345S"
}
Get all information about a kyc.
OK
Bad Request
Unauthorized
Forbidden
Not Found
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "person": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "CONSUMER"
}, - "address": {
- "isoCountryCode": "ABW",
- "city": "string",
- "postalCode": "string",
- "street": "string",
- "number": "string",
- "refinement": "string",
- "stateOrProvince": "string",
- "status": "INVALID"
}, - "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "gender": "MALE",
- "birthDate": "2019-08-24",
- "emailAddress": "string",
- "birthCity": "string",
- "birthIsoCountryCode": "ABW",
- "status": {
- "value": "NOT_STARTED",
- "reason": "string"
}, - "accessType": "LINK",
- "creationDate": "2019-08-24T14:15:22Z",
- "updateDate": "2019-08-24T14:15:22Z"
}