Update KYC Information

Read on updating sender's information

This API is only applicable if you are using API for KYC.

The API allows you to update the sender information. You can provide all the required sender information at once. You can also update the sender information partially by using this API multiple times as required.

You can update sender when the user is in the following KYC status:

• UNVERIFIED

• REVIEW_PENDING

• RETRY

• RETRY_REQUESTED

• DOCUMENT_REQUESTED

• VERIFIED [Can only can update Nationality and Occupation fields if they are null]

PATCH /v2/senders/{{senderId}}/kyc-info

Details

Field	Type	Description
id	UUID	Id of Sender
first_name	String	First name of the sender
middle_name	String	Middle name of the sender
last_name	String	Last name of the sender
gender	String	Gender of the sender
email	String	Email address of the sender
mobile_phone	String	10-15 digit mobile phone number of the sender
date_of_birth	String	Sender's date of birth (yyyy-mm-dd)
address_line1	String	Sender's address line 1
address_line2	String	Sender's address line 2
state	String	2-letter ISO code of the sender's state
city	String	Sender's city
zipcode	String	Sender's zipcode
nationality	String	3-letter ISO code of sender's nationality
sender_company	Object	Sender's company details
sender_company.occupation	String	Sender's occupation
sender_company.company_name	String	Sender's company name
sender_company.company_address	String	Address of sender's company
sender_company.company_phone	String	Phone number of sender's company
kyc_status	Enum	KYC status of sender. UNVERIFIED,IN_PROGRESS, REVIEW_PENDING, RETRY, VERIFIED, RETRY_REQUESTED,DOCUMENT_REQUESTED,SUSPENDED,DOCUMENT
user_agreement	boolean	True if sender remit agreement has been signed

Request Sample

curl --location --request PATCH {{url}}/v2/senders/{{senderId}}/kyc-info' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: clientid ' \
--header 'X-Client-Secret: clientSecret ' \
--data-raw '{
             "first_name": "John",
             "middle_name" : "",
             "last_name": "Doe",
             "mobile_phone": "1234567890",
             "email": "[e-mail]",
             "gender": "male",
             "date_of_birth": "1974-06-17",
             "address_line1": "123 California Avenue",
             "address_line2": "",
             "city": "Santa Monica",
             "state" : "CA",
             "zipcode": "90403",
             "nationality": "USA",
             "user_agreement" : true,
             "sender_company": {
                     "occupation": "Engineer"
                 }
             }'

Response Sample

{
      "id": "senderId",
      "first_name": "John",
      "middle_name" : "Mid",
      "last_name": "Doe",
      "mobile_phone": "1234567890",
      "email": "[e-mail]",
      "gender": "male",
      "date_of_birth": "1974-06-17",
      "address_line1": "123 California Avenue",
      "address_line2": "",
      "city": "Santa Monica",
      "state" : "CA",
      "zipcode": "90403",
      "nationality": "USA",
      "kyc_status": "UNVERIFIED",
      "user_agreement": true
   }