---
title: Register KRA Creds
slug: investor-onboarding-io/register-kra-creds
description: Learn how to register or update your credentials with the KRA (Know Your Customer Registration Agency) using this comprehensive document. It provides the API endpoint for registration, along with sample requests and field descriptions for KRA types includ
createdAt: 2023-05-02T07:10:26.000Z
---

# Introduction

This step is used to register/update the credentials of the KRA.

### API Endpoint - Register Creds

**Preproduction**: 

[https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds](https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds)

**Production**:

[https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds](https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds)

# Sample Request

## CAMS KRA

:::::Tabs
::::Tab{title="Preproduction"}
:::CodeblockTabs
CAMS

```json
  curl --location 'https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <authorization token>' \
--data '{
    "priority": [
        "cams"
    ],
    "rePushDelay":300000,
    "cams": {
        "type": "cams",
        "config": {
            "userId": "camsusername",
            "password": "password"
        }
    }
}'
```

KARVY

```json
  curl --location 'https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <authorization token>' \
--data-raw '{
    "priority": [
        "karvy"
    ],
    "rePushDelay":300000,
    "karvy": {
        "type": "karvy",
        "config": {
            "loginCredentials": {
                "contract": "true",
                "username": "username",
                "password": "password"
            },
            "userId": "3428"
        }
    }
}'
```

CVL

```json
curl --location 'https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <authorization token>' \
--data '{
    "priority": [
        "cvl"
    ],
    "rePushDelay":300000,
    "cvl": {
        "type": "cvl",
        "config": {
            "loginCredentials": {
                "poscode": "",
                "distributorPoscode": "",
                "password": "",
                "username": "",
                "apiKey": ""
            },
            "sftpCredentials": {
                "host": "",
                "port": "",
                "username": "",
                "password": ""
            }
        }
    }
   
}'
```

Multi KRA

```json
curl --location 'https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/customers/creds' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <authorization token>' \
--data '{
    "priority": [
        "karvy",
        "cvl",
        "cams"
    ],
    "rePushDelay": 300000,
    "cvl": {
        "type": "cvl",
        "config": {
            "loginCredentials":{
                "poscode": "",
                "distributorPoscode": "",
                "password": "",
                "username": "",
                "apiKey": ""
            },
            "sftpCredentials": {
                "host": "",
                "port": "",
                "username": "",
                "password": ""
            }
        }
    },
    "karvy": {
        "type": "karvy",
        "config": {
            "loginCredentials": {
                "contract": "true",
                "username": "",
                "password": ""
            },
            "userId": ""
        }
    },
    "cams": {
        "type": "cams",
        "config": {
            "userId": "",
            "password": ""
        }
    }
}
'
```
:::
::::
:::::

"\\"rePushDelay\\" must be one of \[0, 300000, 600000, 900000, 1800000, 3600000, 7200000, 10800000]"

## Request Field Description - CAMS

| **Key**       | **Data Type** | **Required/Optional** | **Description**                                                             |
| ------------- | ------------- | --------------------- | --------------------------------------------------------------------------- |
| **Header**    |               |                       |                                                                             |
| Content-Type  | String        | Required              | application/json                                                            |
| Authorization | String        | Required              | Access token from login                                                     |
| **Body**      |               |                       |                                                                             |
| priority      | List          |                       | Priority of the order in which KRA should be called for pushing onboardings |
| type          | String        |                       | type will be KRA name                                                       |
| userId        | String        |                       | CAMS KRA username                                                           |
| password      | String        |                       | CAMS Password                                                               |

## KARVY KRA

## Request Field Description

| **Key**          | **Data Type** | **Required/Optional** | **Description**                                                             |
| ---------------- | ------------- | --------------------- | --------------------------------------------------------------------------- |
| **Header**       |               |                       |                                                                             |
| Content-Type     | String        | Required              | application/json                                                            |
| Authorization    | String        | Required              | Access token from login                                                     |
| **Body**         |               |                       |                                                                             |
| priority         | List          |                       | Priority of the order in which KRA should be called for pushing onboardings |
| type             | String        |                       | type will be KRA name                                                       |
| config           | Object        |                       | Object to configure KRA Details                                             |
| loginCredentials | String        |                       | Object to configure KRA's credentials                                       |
| contract         | String        |                       | whether the user's contract form would be sent to KRA                       |
| username         | String        |                       | KARVY username                                                              |
| password         | String        |                       | KARVY password                                                              |
| userId           | String        |                       | KARVY user id                                                               |

## CVL KRA

## Request Field Description

| **Key**            | **Data Type** | **Required/Optional** | **Description**                                                                             |
| ------------------ | ------------- | --------------------- | ------------------------------------------------------------------------------------------- |
| **Header**         |               |                       |                                                                                             |
| Content-Type       | String        | Required              | application/json                                                                            |
| Authorization      | String        | Required              | Access token from login                                                                     |
| **Body**           |               |                       |                                                                                             |
| priority           | List          |                       | Priority of the order in which KRA should be called for pushing onboardings                 |
| type               | String        |                       | type will be KRA name                                                                       |
| config             | Object        |                       | Object to configure KRA Details                                                             |
| loginCredentials   | Object        |                       | Object to configure KRA's credentials                                                       |
| poscode            | String        |                       | CVL Poscode                                                                                 |
| password           | String        |                       | CVL Password                                                                                |
| username           | String        |                       | CVL Username                                                                                |
| distributorPoscode | String        | Optional              | RTA licensed distributor poscode and other credentials should be provided for RTA use only. |
| apiKey             | String        | Required              | API key provided by cvl for json api                                                        |
| sftpCredentials    | Object        |                       | object to configure SFTP credentials                                                        |
| host               | String        |                       | SFTP Host name                                                                              |
| port               | String        |                       | SFTP Port no                                                                                |
| username           | String        |                       | SFTP username                                                                               |
| password           | String        |                       | SFTP password                                                                               |

# Sample Responses

:::CodeblockTabs
200

```json
{
    "status": 200,
    "message": "Credentials are updated"
}
```

400

```json
Syntax Error:
{
    "error": {
        "statusCode": 400,
        "name": "SyntaxError",
        "message": "Unexpected string in JSON at position 147"
    }
}
```

401

```json
{
    "error": {
        "statusCode": 401,
        "name": "Error",
        "message": "Authorization Required",
        "code": "AUTHORIZATION_REQUIRED"
    }
}
```

403

```json
Access Forbidden:

The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why. This code is used when requests are being denied due to request limits.

```

404

```json
{
    "error": {
        "statusCode": 404,
        "name": "Error",
        "message": "There is no method to handle POST /custmers/creds"
    }
}
```

500

```html
<html>

<head>

    <title>502 Bad Gateway</title>

</head>

<body>

    <center>

        <h1>502 Bad Gateway</h1>

    </center>

</body>

</html>
```
:::

:::hint{type="info"}
### Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.


You can reach out to us at [help@signzy.com](#).
:::

