--- title: Update Fatca Form slug: investor-onboarding-io/update-fatca-form description: This document outlines an API endpoint for updating a FATCA compliance form. It explains the necessary headers and JSON input with merchant information, form type, and FATCA data. The document also covers required fields and possible values for subfields, docTags: createdAt: 2023-06-19T12:35:52.000Z --- ## Endpoint **/api/onboardings/updateForm** ## Headers | **Property** | **Value** | | ------------- | ------------------------------------------------- | | Content-type | application/json | | Authorization | …access token… (alphanumeric string of length 64) | ## Input ```json { "merchantId":"...", "save":"formData", "type":"fatca", "data":{ "type":"fatca", "fatcaData":{ "pep":"...", "rpep":"...", "residentForTaxInIndia":"...", "relatedPerson":"...", "addressType":"...", "countryCodeJurisdictionResidence":"...", "countryJurisdictionResidence":"...", "taxIdentificationNumber":"...", "placeOfBirth":"...", "countryCodeOfBirth":"...", "countryOfBirth":"...", "addressCity":"...", "addressDistrict":"...", "addressStateCode":"...", "addressState":"... ...", "addressCountryCode":"...", "addressCountry":"...", "addressPincode": "543534", "address":"...", "relatedPersonType":"...", "relatedPersonKycNumber":"44354355", "relatedPersonKycNumberExists":"...", "relatedPersonTitle":"....", "relatedPersonIdentityProof":{ "name":"....", "fatherName":"...", "dob":"...", "number":"..." }, "relatedPersonName":"...", "relatedPersonIdentityProofType":"..." } } } ``` | **Property** | **Data Type** | **Example Values** | | ---------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | merchantId | String (*Required*), alphanumeric string of length 24 | userId from investor login response field | | save | Enum String (*Required*) | “formData” | | type | Enum String (*Required*) | “fatca” | | data | Object (*Required*) | payload | | –type | Enum String (*Required*) | “fatca” | | –fatcaData | Object (*Required*) | fatca data | | —-pep | Enum String (*Required*) | whether a 'politically exposed person’ values: “YES”/“NO” | | —-rpep | Enum String (*Required*) | whether a 'related to a politically exposed person’ values: “YES”/“NO” | | —-residentForTaxInIndia | Enum String (*Required*) | whether a 'resident outside of India’ values: “YES”/“NO” | | —-countryCodeJurisdictionResidence | Enum String (*Optional*) | Country of Jurisdiction of Residence code (Refer Table 1.1), to be provided given “residentForTaxInIndia” is “YES” | | —-countryJurisdictionResidence | String(*Optional*) | Country of Jurisdiction of Residence (Refer Table 1.1), to be provided given “residentForTaxInIndia” is “YES” | | —-taxIdentificationNumber | String(*Optional*) | Tax Identification Number, to be provided given “residentForTaxInIndia” is “YES” | | —-placeOfBirth | String(*Optional*) | Place of Birth, to be provided given “residentForTaxInIndia” is “YES” | | —-countryCodeOfBirth | Enum String(*Optional*) | Country code of birth (Refer Table 1.1), to be provided given “residentForTaxInIndia” is “YES” | | —-countryOfBirth | String(*Optional*) | Country of birth (Refer Table 1.1), to be provided given “residentForTaxInIndia” is “YES” | | —-addressType | String(*Optional*) | Type of fatca address, values: “correspondence” / “others”, to be provided given “residentForTaxInIndia” is “YES” | | —-addressCity | String(*Optional*) | Fatca address city, to be provided given “residentForTaxInIndia” is “YES” | | —-addressDistrict | String (*Optional*) | Fatca address district, to be provided given “residentForTaxInIndia” is “YES” | | —-addressStateCode | Enum String(*Optional*) | Fatca address state code (Refer Table 1.2), to be provided given “residentForTaxInIndia” is “YES” | | —-addressState | String(*Optional*) | Fatca address State (Refer Table 1.2), to be provided given “residentForTaxInIndia” is “YES” | | —-addressCountryCode | Enum String(*Optional*) | Fatca address Country code (Refer Table 1.1), to be provided given “residentForTaxInIndia” is “YES” | | —-addressCountry | String(*Optional*) | Fatca address country (Refer Table 1.1), to be provided given “residentForTaxInIndia” is “YES” | | —-addressPincode | String(*Optional*), valid Pincode | Fatca address Pincode, to be provided given “residentForTaxInIndia” is “YES” | | —-address | String(*Optional*) | Fatca address, to be provided given “residentForTaxInIndia” is “YES” | | —-relatedPerson | Enum String(*Optional*) | whether a related person to the investor or investor themselves, values: “YES” / “NO” | | —-relatedPersonType | Enum String(*Optional*) | Type of related person, values: “1” / “2” / “3” for “Guardian of a Minor”, “Assignee”, and “Authorised Representative” respectively, *Required* if the related person is applicable (relatedPerson is “YES”) | | —-relatedPersonKycNumberExists | Enum String(*Optional*) | whether related person has a KYC number, values: “YES”/“NO”, *Required* if related person is applicable (relatedPerson is “YES”) | | —-relatedPersonKycNumber | String (*Optional*), valid Kyc number | KYC number of related person (*Required* if relatedPersonKycNumberExists is “YES”) | | —-relatedPersonTitle | String | Related Person Title, values: “Mr.”/ “Mrs.” / “Ms.” / “Mx.”, *Required* if related person is applicable (relatedPerson is “YES”) | | —-relatedPersonName | String | Name of related person, *Required* if related person is applicable (relatedPerson is “YES”) | | —-relatedPersonIdentityProof | Object | *Required* if related person is applicable(relatedPerson is “YES”), see below for details | | —-relatedPersonIdentityProofType | Enum String(*Optional*) | Type of related persons ID proof, values: “individualPan”/“aadhaar”/“passport”/“drivingLicence”/“voterId, *Required* if related person is applicable (relatedPerson is “YES”) | ### relatedPersonIdentityProof Object Details when Related Person’s POI is PAN | **Property** | **Data Type** | **Example Values** | | ------------ | ------------------------------------------------------------------------------- | -------------------------- | | type | Enum String (*Required*) | “individualPan” | | name | String (*Required*), string of min length of 2 consisting of any character | Name on POI document | | dob | String (*Required*), date of birth as string in DD/MM/YYYY or DD-MM-YYYY format | DOB on POI document | | number | String (*Required*), valid PAN number | PAN number on POI document | | fatherName | String (*Required*), string of min length of 2 consisting of any character | PAN number on POI document | ### relatedPersonIdentityProof Object Details when Related Person’s POI is Aadhaar | **Property** | **Data Type** | **Example Values** | | ------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------- | | type | Enum String (*Required*) | “aadhaar” | | name | String (*Required*), string of min length of 2 consisting of any character | Name on POI document | | uid | String (*Required*), string of 8 zeros followed by 4 digits | Aadhaar number | | address | String (*Required*) | Address as on POI document | | city | Enum String (*Required*) | City as on POI document | | state | Enum String (*Required*) | State as on POI document, Refer 1st column of Table 1.7 | | district | String (*Required*) | District as on POI document | | pincode | String (*Required*), valid Pincode | Pincode | | dob | String (*Required*), date of birth as string in DD/MM/YYYY or DD-MM-YYYY format | DOB on POI document | ### relatedPersonIdentityProof Object Details when Related Person’s POI is Passport | **Property** | **Data Type** | **Example Values** | | -------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | | type | Enum String (*Required*) | “passport” | | name | String (*Required*), string of min length of 2 consisting of any character | Name on POI document | | passportNumber | String (*Required*) | Passport number | | address | String (*Required*) | Address as on POI document | | city | Enum String (*Required*) | City as on POI document | | state | Enum String (*Required*) | State as on POI document, Refer 1st column of Table 1.7 | | district | String (*Required*) | District as on POI document | | birthDate | String (*Required*), date of birth as string in DD/MM/YYYY or DD-MM-YYYY format | DOB on POI document | | pincode | String (*Required*), valid Pincode | Pincode | | issueDate | String (*Required*), Issue Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a past Date | Issue date on the document | | expiryDate | String (*Required*), Expiry Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a future Date | Expiry date on the document | ### relatedPersonIdentityProof Object Details when Related Person’s POI is Driving License | **Property** | **Data Type** | **Example Values** | | ------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | | type | Enum String (*Required*) | “drivingLicence” | | name | String (*Required*), string of min length of 2 consisting of any character | Name on POI document | | dob | String (*Required*), date of birth as string in DD/MM/YYYY or DD-MM-YYYY format | DOB on POI document | | number | String (*Required*) | Driving License number on POI document | | address | String (*Required*) | Address as on POI document | | city | Enum String (*Required*) | City as on POI document | | state | Enum String (*Required*) | State as on POI document, Refer 1st column of Table 1.7 | | district | String (*Required*) | District as on POI document | | pincode | String (*Required*), valid Pincode | Pincode | | issueDate | String (*Required*), Issue Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a past Date | Issue date on the document | | expiryDate | String (*Required*), Expiry Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a future Date | Expiry date on the document | ### relatedPersonIdentityProof Object Details when Related Person’s POI is VoterId | **Property** | **Data Type** | **Example Values** | | ------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------- | | type | Enum String (*Required*) | “voterId” | | name | String (*Required*), string of min length of 2 consisting of any character | Name on POI document | | dob | String (*Required*), date of birth as string in DD/MM/YYYY or DD-MM-YYYY format | DOB on POI document | | epicNumber | String (*Required*) | VoterId number on POI document | | address | String (*Required*) | Address as on POI document | | city | Enum String (*Required*) | City as on POI document | | state | Enum String (*Required*) | State as on POI document, Refer 1st column of Table 1.7 | | district | String (*Required*) | District as on POI document | | pincode | String (*Required*), valid Pincode | Pincode | ## Expected Output ```json { "object": "Updated Successfully" } ``` :::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](#). :::