Sandbox

Reset the SCA endpoint of a user

Reset the SCA endpoint (device) of an end-user in order to enroll a new one.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
endUserId
string <uuid>

Mandatory if not authenticated as end-user

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

delete/api/partner/sca
Request samples
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5"
}
Response samples
application/json
{
  • "errorCode": "END_USER_NOT_FOUND",
  • "status": 409,
  • "error": "linkcy.conflict",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Initialize or reset a password with secret in response

Whether you want to initialize first password or reset a password, you should use this endpoint. Send a secret in response that can be used to change the password of the account.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
Any of:
consumerPhone
required
string^[0-9]{2,17}$

The complete consumer's phone, including country code. Must not contain +.

partnerName
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/api/partner/passwords/reset/sandbox
Request samples
application/json
{
  • "consumerPhone": "33123456789",
  • "partnerName": "string"
}
Response samples
application/json
{
  • "passwordChangeSecret": "string"
}

Credit a ledger

Used to simulate an external credit to a ledger, http errors are not yet handled/no validation. The amount can contain 2 decimal places and the maximum is 250 000.

SecurityLinkcy-Auth
Request
path Parameters
ledgerId
required
string <uuid>
Request Body schema: application/json
amount
required
number
Responses
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

post/api/partner/ledgers/credit/{ledgerId}
Request samples
application/json
{
  • "amount": 0
}
Response samples
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Simulate a KYC result for a consumer or a corporate-related person

Simulate a KYC for a consumer or corporate related person by specifying the new desired KYC status.

The person information will be automatically populated with default values.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
Any of:
consumerId
string <uuid>

Id of the consumer doing the KYC (Will be ignored and deducted from current authenticated user if consumer)

kycStatus
required
string

The new KYC status

Enum: "NOT_STARTED" "CREATED" "PROCESSING" "PENDING_REVIEW" "ABORTED" "VALIDATED" "DECLINED"
Responses
201

Simulated KYC successfully created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/api/partner/kyc/simulate
Request samples
application/json
{
  • "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
  • "kycStatus": "NOT_STARTED"
}
Response samples
application/json
{
  • "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65",
  • "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e"
}

Delete a corporate

Delete a corporate by id. This endpoint allows you to try again the whole corporate creation flow.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

delete/api/partner/corporates/{corporateId}
Request samples
Response samples
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Manually bypass a corporate's KYB status

Used to update manually the KYB status of a corporate in order to try different use cases.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
Request Body schema: application/json
kybStatus
required
string

The new KYB status

Enum: "NOT_STARTED" "COMPLETING" "COMPLETED" "PENDING_VERIFICATION" "NEED_ADDITIONAL_INFORMATION" "DECLINED" "VALIDATED" "PROCESSING"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

patch/api/partner/corporates/{corporateId}/kyb
Request samples
application/json
{
  • "kybStatus": "NOT_STARTED"
}
Response samples
application/json
{
  • "corporateId": "50eb73c4-9d2f-4e30-9f0c-2d57c30a46ee"
}

Delete a consumer

Delete a consumer by id. This endpoint allows you to try again the whole consumer creation flow.

SecurityLinkcy-Auth
Request
path Parameters
consumerId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

delete/api/partner/consumers/{consumerId}
Request samples
Response samples
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get a card truncated PAN

Used to get the truncated PAN of a card (that you will not receive) in order to activate it.

SecurityLinkcy-Auth
Request
path Parameters
cardId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

get/api/partner/cards/{cardId}/pan
Request samples
Response samples
application/json
"string"